Skip to content

Commit befe529

Browse files
Merge pull request #243 from splunk/chili_branch
2 parents 09c221a + b7f7400 commit befe529

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
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

examples/searchcommands_app/package/README/logging.conf.spec

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
#
44
# [Configuration file format](https://docs.python.org/2/library/logging.config.html#configuration-file-format)
55
#
6-
# This file must contain sections called [loggers], [handlers] and [formatters] which identify by name the entities of
7-
# each type which are defined in the file. For each such entity, there is a separate section which identifies how that
6+
# This file must contain sections called [loggers], [handlers] and [formatters] that identify by name the entities of
7+
# each type that are defined in the file. For each such entity, there is a separate section that identifies how that
88
# entity is configured. Thus, for a logger named log01 in the [loggers] section, the relevant configuration details are
99
# held in a section [logger_log01]. Similarly, a handler called hand01 in the [handlers] section will have its
1010
# configuration held in a section called [handler_hand01], while a formatter called form01 in the [formatters] section
@@ -24,7 +24,7 @@ keys = <comma-separated strings>
2424
* The root logger must specify a level and a list of handlers.
2525

2626
level = [critical|error|warning|info|debug|notset]
27-
* Can be one of debug, info, warning, error, critical or notset. For the root logger only, notset means that all
27+
* Can be one of debug, info, warning, error, critical, or notset. For the root logger only, notset means that all
2828
* messages will be logged. Level values are evaluated in the context of the logging packages namespace.
2929
* Defaults to warning.
3030

@@ -43,7 +43,7 @@ qualname = <string>
4343
level = [critical|error|warning|info|debug|notset]
4444
* Can be one of debug, info, warning, error, critical or notset. For the root logger only, notset means that all
4545
* messages will be logged. Level values are evaluated in the context of the logging packages namespace.
46-
* Defaults to warning
46+
* Defaults to warning.
4747

4848
handlers = <comma-separated strings>
4949
* A comma-separated list of handler names, which must appear in the [handlers] section. These names must appear in
@@ -57,7 +57,7 @@ propagate = [0|1]
5757

5858
[handlers]
5959
* Specifies a list of handler keys.
60-
* See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html)
60+
* See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html).
6161

6262
keys = <comma-separated strings>
6363
* A comma-separated list of handlers keys. Each key must have a corresponding [handler_<string>] section in the
@@ -77,7 +77,7 @@ class = <string>
7777

7878
level = [critical|error|warning|info|debug|notset]
7979
* Can be one of debug, info, warning, error, critical or notset. This value is interpreted as for loggers, and
80-
* notset is taken to mean, "log everything."
80+
* notset is taken to mean, "log everything".
8181

8282
formatter = <string>
8383
* Specifies the key name of the formatter for this handler. If a name is specified, it must appear in the
@@ -86,7 +86,7 @@ formatter = <string>
8686

8787
[formatters]
8888
* Specifies a list of formatter keys.
89-
* See [logging.formatters](https://docs.python.org/2/howto/logging.html#formatters)
89+
* See [logging.formatters](https://docs.python.org/2/howto/logging.html#formatters).
9090

9191
keys = <comma-separated strings>
9292
* A comma-separated list of formatter keys. Each key must have a corresponding [formatter_<string>] section in the

0 commit comments

Comments
 (0)