Merge branch 'feature/extras' into develop

Author: blovering

CHANGELOG.md

@@ -11,7 +11,15 @@
   `count`, `offset`, `search`, `sort_dir`, `sort_key` and `sort_mode`. Note
   that `Inputs` and `Jobs` are not pageable collections and only support basic
   enumeration and iteration.
-* Improvements to unit tests
+* Support for event types:
+    - Added Service.event_types + units
+    - Added examples/event_types.py
+* Support for fired alerts:
+    - Added Service.fired_alerts + units
+    - Added examples/fired_alerts.py
+* Support for saved searches:
+    - Added Service.saved_searches + units
+    - Added examples/saved_searches.py
 
 ### Breaking changes
 

examples/event_types.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2012 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.
+
+"""A command line utility that lists Splunk event types."""
+
+import sys
+
+from splunklib.client import connect
+
+from utils import parse
+
+def main():
+    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    service = connect(**opts.kwargs)
+
+    for item in service.event_types:
+        print "%s" % item.name
+        print '='*len(item.name)
+        content = item.content
+        for key in sorted(content.keys()):
+            value = content[key]
+            print "%s: %s" % (key, value)
+        print
+
+if __name__ == "__main__":
+    main()
+
+

examples/fired_alerts.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2012 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.
+
+"""A command line utility that prints out fired alerts."""
+
+import sys
+
+from splunklib.client import connect
+
+from utils import parse
+
+def main():
+    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    service = connect(**opts.kwargs)
+
+    for group in service.fired_alerts:
+        header = "%s (count: %d)" % (group.name, group.count)
+        print "%s" % header
+        print '='*len(header)
+        alerts = group.alerts
+        for alert in alerts.list():
+            content = alert.content
+            for key in sorted(content.keys()):
+                value = content[key]
+                print "%s: %s" % (key, value)
+            print
+
+if __name__ == "__main__":
+    main()
+
+

examples/index.py

@@ -29,7 +29,6 @@
     disable [<index>]+
     enable [<index>]+
     list [<index>]*
-    reload [<index>]+
     update <index> [options]
 
 Examples:
@@ -119,17 +118,13 @@ def run(self, argv):
             'disable': self.disable,
             'enable': self.enable,
             'list': self.list,
-            'reload': self.reload,
             'update': self.update,
         }
         handler = handlers.get(command, None)
         if handler is None:
             error("Unrecognized command: %s" % command, 2)
         handler(argv[1:])
 
-    def reload(self, argv):
-        self.foreach(argv, lambda index: index.reload())
-
     def foreach(self, argv, func):
         """Apply the function to each index named in the argument vector."""
         opts = cmdline(argv)

examples/inputs.py

@@ -27,11 +27,14 @@ def main():
     service = connect(**opts.kwargs)
 
     for item in service.inputs:
-        print "%s (%s)" % (item.name, item.kind)
+        header =  "%s (%s)" % (item.name, item.kind)
+        print header
+        print '='*len(header)
         content = item.content
         for key in sorted(content.keys()):
             value = content[key]
-            print "    %s: %s" % (key, value)
+            print "%s: %s" % (key, value)
+        print
 
 if __name__ == "__main__":
     main()

examples/saved_searches.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2012 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.
+
+"""A command line utility that lists saved searches."""
+
+import sys
+
+from splunklib.client import connect
+
+from utils import parse
+
+def main():
+    opts = parse(sys.argv[1:], {}, ".splunkrc")
+    service = connect(**opts.kwargs)
+
+    for saved_search in service.saved_searches:
+        header = saved_search.name
+        print header
+        print '='*len(header)
+        content = saved_search.content
+        for key in sorted(content.keys()):
+            value = content[key]
+            print "%s: %s" % (key, value)
+        history = saved_search.history()
+        if len(history) > 0:
+            print "history:"
+            for job in history:
+                print "    %s" % job.name
+        print
+
+if __name__ == "__main__":
+    main()
+
+

splunklib/binding.py

@@ -298,6 +298,9 @@ def __init__(self, response):
     def __str__(self):
         return self.read()
 
+    def close(self):
+        self._response.close()
+
     def read(self, size = None):
         return self._response.read(size)