Skip to content

Commit 6d71c2c

Browse files
authored
Update README.md
1 parent 09c221a commit 6d71c2c

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

examples/searchcommands_app/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
splunk-sdk-python searchcommands_app example
22
=============================================
33

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:
55

66
Command | Type | Description
77
:---------------- |:-----------|:-------------------------------------------------------------------------------------------
88
countmatches | Streaming | Counts the number of non-overlapping matches to a regular expression in a set of fields.
99
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.
1315

1416
The app is tested on Splunk 5 and 6. Here is its manifest:
1517

@@ -59,15 +61,15 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
5961

6062
The tarball is build as build/searchcommands_app-1.5.0-private.tar.gz.
6163

62-
+ And then (re)start Splunk so that the app is recognized.
64+
+ Then (re)start Splunk so that the app is recognized.
6365

6466
## Dashboards and Searches
6567

66-
+ TODO: Add saved search(es) for each example
68+
+ TODO: Add saved search(es) for each example.
6769

6870
### Searches
6971

70-
+ TODO: Describe saved searches
72+
+ TODO: Describe saved searches.
7173

7274
## License
7375

0 commit comments

Comments
 (0)