Merge pull request #78 from glennblock/develop

Adding HelloWorldCommand

Author: David Noble

examples/searchcommands_app/README.md

@@ -1,11 +1,11 @@
 splunk-sdk-python search_commands_app example
 =============================================
 
-This app provides three examples of custom search commands; one of each of the
-base types:
+This app provides several examples of custom search commands which illustrate each of the base types:
 
  Command      | Type       | Description
 :------------ |:-----------|:----------------------------------------------------
+ generatehello| Generating | Generates a specified number of 'Hello World' events
  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.
  countmatches | Streaming  | Counts the number of non-overlapping matches to a regular expression in a set of fields.
@@ -18,7 +18,8 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
 │   │   └── searchcommands ....... splunklib.searchcommands module
 │   ├── simulate.py .............. SimulateCommand implementation
 │   ├── sum.py ................... SumCommand implementation
-│   └── countmatches.py .......... CountMatchesCommand implementation
+│   ├── countmatches.py .......... CountMatchesCommand implementation
+│   └── generatehello.py ........... HelloWorldCommand implementation
 ├── default
 │   ├── data
 │   │   └── ui

examples/searchcommands_app/bin/generatehello.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2014 Splunk, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import sys, time
+from splunklib.searchcommands import \
+  dispatch, GeneratingCommand, Configuration, Option, validators
+ 
+@Configuration()
+class GenerateHelloCommand(GeneratingCommand):
+  count = Option(require=True, validate=validators.Integer())
+ 
+  def generate(self):
+    for i in range(1, self.count + 1):
+      text = 'Hello World %d' % i
+      yield {'_time': time.time(), 'event_no': i, '_raw': text } 
+ 
+dispatch(GenerateHelloCommand, sys.argv, sys.stdin, sys.stdout, __name__)

examples/searchcommands_app/default/commands.conf

@@ -24,3 +24,11 @@ supports_rawargs = true
 
 outputheader = true
 requires_srinfo = true
+
+[generatehello]
+filename = generatehello.py
+supports_getinfo = true
+supports_rawargs = true
+
+outputheader = true
+requires_srinfo = true

examples/searchcommands_app/default/logging.conf

@@ -4,7 +4,7 @@
 #     [Configuration file format](http://goo.gl/K6edZ8)
 #
 [loggers]
-keys = root, CountMatchesCommand, SimulateCommand, SumCommand
+keys = root, CountMatchesCommand, SimulateCommand, SumCommand, HelloWorldCommand
 
 [logger_root]
 level = WARNING   ; Default: WARNING
@@ -28,6 +28,12 @@ level = NOTSET    ; Default: WARNING
 handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
+[logger_GenerateHelloCommand]
+qualname = GenerateHelloCommand
+level = NOTSET    ; Default: WARNING
+handlers = file   ; Default: stderr
+propagate = 0     ; Default: 1
+
 [handlers]
 # See [logging.handlers](http://goo.gl/9aoOx)
 keys=file, stderr

examples/searchcommands_app/default/searchbnf.conf

@@ -59,3 +59,19 @@ maintainer = dnoble
 usage = public
 related = stats
 tags = searchcommands_app
+
+[generatehello-command]
+syntax = generatehello count=<count> 
+alias =
+shortdesc = Creates a set of 'Hello World' events.
+description = This command creates a specified number of dummy events.
+comment1 = This example generates 5 events
+example1 = | generatehello count=5
+category = generating
+appears-in = 5.0
+maintainer = gblock
+usage = public
+related = stats
+tags = searchcommands_app
+
+