From 6d71c2c40a8ea717330c44fd7c62245af2a142a0 Mon Sep 17 00:00:00 2001 From: taylorcole44 <44789670+taylorcole44@users.noreply.github.com> Date: Thu, 7 Feb 2019 14:34:56 -0800 Subject: [PATCH 1/2] Update README.md --- examples/searchcommands_app/README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/examples/searchcommands_app/README.md b/examples/searchcommands_app/README.md index 61bb4673a..88a739841 100644 --- a/examples/searchcommands_app/README.md +++ b/examples/searchcommands_app/README.md @@ -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: @@ -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 From b7f740003489b0365c1adb2a5a32e54bbbac09d7 Mon Sep 17 00:00:00 2001 From: taylorcole44 <44789670+taylorcole44@users.noreply.github.com> Date: Thu, 7 Feb 2019 14:45:41 -0800 Subject: [PATCH 2/2] Update logging.conf.spec --- .../package/README/logging.conf.spec | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/searchcommands_app/package/README/logging.conf.spec b/examples/searchcommands_app/package/README/logging.conf.spec index 3f134757b..c9b93118a 100644 --- a/examples/searchcommands_app/package/README/logging.conf.spec +++ b/examples/searchcommands_app/package/README/logging.conf.spec @@ -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 @@ -24,7 +24,7 @@ keys = * 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. @@ -43,7 +43,7 @@ qualname = 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 = * 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] [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 = * A comma-separated list of handlers keys. Each key must have a corresponding [handler_] section in the @@ -77,7 +77,7 @@ class = 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 = * 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 = [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 = * A comma-separated list of formatter keys. Each key must have a corresponding [formatter_] section in the