Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions examples/searchcommands_app/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
splunk-sdk-python searchcommands_app example
=============================================

This app provides several examples of custom search commands which illustrate each of the base types:
This app provides several examples of custom search commands that illustrate each of the base command types:

Command | Type | Description
:---------------- |:-----------|:-------------------------------------------------------------------------------------------
countmatches | Streaming | Counts the number of non-overlapping matches to a regular expression in a set of fields.
generatetext | Generating | Generates a specified number of events containing a specified text string.
pypygeneratetext | | Executes generatetext with PyPy
simulate | Generating | Generates a sequence of events drawn from a csv file using repeated random sampling with replacement
sum | Reporting | Adds all the numbers in a set of fields.
pypygeneratetext | Generating | Executes generatetext with the string 'PyPy'.
simulate | Generating | Generates a sequence of events drawn from a csv file using repeated random sampling with replacement.
generatehello | Generating | Generates a specified number of events containing the text string 'hello'.
sum | Reporting | Adds all of the numbers in a set of fields.
filter | Eventing | Filters records from the events stream based on user-specified criteria.

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

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

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

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

## Dashboards and Searches

+ TODO: Add saved search(es) for each example
+ TODO: Add saved search(es) for each example.

### Searches

+ TODO: Describe saved searches
+ TODO: Describe saved searches.

## License

Expand Down
14 changes: 7 additions & 7 deletions examples/searchcommands_app/package/README/logging.conf.spec
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
#
# [Configuration file format](https://docs.python.org/2/library/logging.config.html#configuration-file-format)
#
# This file must contain sections called [loggers], [handlers] and [formatters] which identify by name the entities of
# each type which are defined in the file. For each such entity, there is a separate section which identifies how that
# This file must contain sections called [loggers], [handlers] and [formatters] that identify by name the entities of
# each type that are defined in the file. For each such entity, there is a separate section that identifies how that
# entity is configured. Thus, for a logger named log01 in the [loggers] section, the relevant configuration details are
# held in a section [logger_log01]. Similarly, a handler called hand01 in the [handlers] section will have its
# configuration held in a section called [handler_hand01], while a formatter called form01 in the [formatters] section
Expand All @@ -24,7 +24,7 @@ keys = <comma-separated strings>
* The root logger must specify a level and a list of handlers.

level = [critical|error|warning|info|debug|notset]
* Can be one of debug, info, warning, error, critical or notset. For the root logger only, notset means that all
* Can be one of debug, info, warning, error, critical, or notset. For the root logger only, notset means that all
* messages will be logged. Level values are evaluated in the context of the logging package’s namespace.
* Defaults to warning.

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

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

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

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

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

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

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

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