|
1 | 1 | splunk-sdk-python searchcommands_app example |
2 | 2 | ============================================= |
3 | 3 |
|
4 | | -This app provides several examples of custom search commands which illustrate each of the base types: |
| 4 | +This app provides several examples of custom search commands that illustrate each of the base command types: |
5 | 5 |
|
6 | 6 | Command | Type | Description |
7 | 7 | :---------------- |:-----------|:------------------------------------------------------------------------------------------- |
8 | 8 | countmatches | Streaming | Counts the number of non-overlapping matches to a regular expression in a set of fields. |
9 | 9 | generatetext | Generating | Generates a specified number of events containing a specified text string. |
10 | | - pypygeneratetext | | Executes generatetext with PyPy |
11 | | - simulate | Generating | Generates a sequence of events drawn from a csv file using repeated random sampling with replacement |
12 | | - sum | Reporting | Adds all the numbers in a set of fields. |
| 10 | + pypygeneratetext | Generating | Executes generatetext with the string 'PyPy'. |
| 11 | + simulate | Generating | Generates a sequence of events drawn from a csv file using repeated random sampling with replacement. |
| 12 | + generatehello | Generating | Generates a specified number of events containing the text string 'hello'. |
| 13 | + sum | Reporting | Adds all of the numbers in a set of fields. |
| 14 | + filter | Eventing | Filters records from the events stream based on user-specified criteria. |
13 | 15 |
|
14 | 16 | The app is tested on Splunk 5 and 6. Here is its manifest: |
15 | 17 |
|
@@ -59,15 +61,15 @@ The app is tested on Splunk 5 and 6. Here is its manifest: |
59 | 61 |
|
60 | 62 | The tarball is build as build/searchcommands_app-1.5.0-private.tar.gz. |
61 | 63 |
|
62 | | -+ And then (re)start Splunk so that the app is recognized. |
| 64 | ++ Then (re)start Splunk so that the app is recognized. |
63 | 65 |
|
64 | 66 | ## Dashboards and Searches |
65 | 67 |
|
66 | | -+ TODO: Add saved search(es) for each example |
| 68 | ++ TODO: Add saved search(es) for each example. |
67 | 69 |
|
68 | 70 | ### Searches |
69 | 71 |
|
70 | | -+ TODO: Describe saved searches |
| 72 | ++ TODO: Describe saved searches. |
71 | 73 |
|
72 | 74 | ## License |
73 | 75 |
|
|
0 commit comments