You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spl2-sample-apps/sample_spl2_pii_masking/README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ In addition, this app shows how to:
15
15
16
16
* Organize your app modules for customization and reuse.
17
17
* Use a separate module that contains views for specific user roles and capabilities. You can mask sensitive employee ID data in an index for most users, while keeping that data unmasked for privileged roles.
18
-
*How to specify a custom command function to masking out sensitive data.
18
+
*Specify a custom command function to masking out sensitive data.
19
19
* Use a dataset literal to provide sample data for the app.
20
20
* Import a view into your _default module.
21
21
* Export views.
@@ -26,7 +26,13 @@ This app is compatible with Splunk Enterprise.
26
26
27
27
You need a pre-release version of Splunk Enterprise that supports SPL2-based applications. See [SPL2 Public Beta overview](https://dev.splunk.com/enterprise/docs/developapps/createspl2apps/spl2previewoverview) for information about the Beta.
28
28
29
-
## Installation
29
+
## Accessing the sample app
30
+
31
+
The app is available in the [spl2-sample-apps](https://github.com/splunk/splunk-app-examples/tree/master/spl2-sample-apps/sample_spl2_pii_masking) folder on the Splunk GitHub Examples repository.
32
+
33
+
The app is uncompressed so that you can view the app folder structure, the modules, and other resources that are included with the app.
34
+
35
+
<!--## Installation
30
36
31
37
Complete the following steps to install a SPL2-based application:
32
38
@@ -37,7 +43,7 @@ Complete the following steps to install a SPL2-based application:
37
43
4. Locate the app file and select **Upload**. You might be prompted to restart the Splunk Enterprise instance.
38
44
39
45
2. Verify that the app appears in the **Apps** drop-down. You can also find the app on your pre-release instance in the `$SPLUNK_HOME/etc/apps/<app_name>`folder.
40
-
46
+
-->
41
47
## App information
42
48
43
49
This app was developed by Splunk.
@@ -49,7 +55,7 @@ This app was developed by Splunk.
49
55
| App file name | sample_spl2_pii_masking.spl ||
50
56
| Namespace | apps.sample_spl2_pii_masking ||
51
57
| Module |_default | This module contains all of the searches for this app. |
52
-
| Module | functions | This module contains the custom command function `pii_mask`, which masks sensitive employee ID data in a dataset.
58
+
| Module | functions | This module contains the custom command function `pii_mask`, which masks sensitive employee ID data in a dataset.|
53
59
| Module | sample_data | This module contains a dataset literal of a sample set of events. |
54
60
| View | $masked_view | This view returns all of the events with masked email addresses.
55
61
This view is used to create the 'Failed logins (masked)' report. |
@@ -98,4 +104,4 @@ Alternatively, you can email us at `spl2@splunk.com`.
0 commit comments