Improved error handling

Signed-off-by: David Noble <[email protected]>

Author: David Noble

examples/searchcommands_app/default/logging.conf

@@ -13,25 +13,34 @@ handlers = stderr ; Default: stderr
 [logger_CountMatchesCommand]
 qualname = CountMatchesCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [logger_SimulateCommand]
 qualname = SimulateCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [logger_SumCommand]
 qualname = SumCommand
 level = NOTSET    ; Default: WARNING
-handlers = stderr ; Default: stderr
+handlers = file   ; Default: stderr
 propagate = 0     ; Default: 1
 
 [handlers]
-keys=stderr
+# See [logging.handlers](http://goo.gl/9aoOx)
+keys=file, stderr
+
+[handler_file]
+# Select this handler to log events to $SPLUNK_HOME/etc/apps/searchcommands_app/searchcommands_app.log
+class = logging.FileHandler
+level = NOTSET
+args = ('searchcommand_app.log', 'a', 'utf-8', True)
+formatter = search_command
 
 [handler_stderr]
+# Select this handler to log events to $SPLUNK_HOME/var/log/splunk/splunkd.log
 class = logging.StreamHandler
 level = NOTSET
 args = (sys.stderr,)

splunklib/searchcommands/generating_command.py

@@ -76,12 +76,9 @@ def generate(self):
         raise NotImplementedError('GeneratingCommand.generate(self)')
 
     def _execute(self, operation, reader, writer):
-        try:
-            for record in operation():
-                writer.writerow(record)
-        except Exception as e:
-            from traceback import format_exc
-            self._exit(format_exc(), e, 1)
+        for record in operation():
+            writer.writerow(record)
+        return
 
     def _prepare(self, argv, input_file):
         ConfigurationSettings = type(self).ConfigurationSettings

splunklib/searchcommands/reporting_command.py

@@ -72,12 +72,9 @@ def reduce(self, records):
         raise NotImplementedError('reduce(self, records)')
 
     def _execute(self, operation, reader, writer):
-        try:
-            for record in operation(SearchCommand.records(reader)):
-                writer.writerow(record)
-        except Exception as e:
-            from traceback import format_exc
-            self._exit(format_exc(), e, 1)
+        for record in operation(SearchCommand.records(reader)):
+            writer.writerow(record)
+        return
 
     def _prepare(self, argv, input_file):
         if len(argv) >= 3 and argv[2] == '__map__':

splunklib/searchcommands/search_command.py

@@ -59,7 +59,6 @@ def __init__(self):
         self._configuration = None
         self._fieldnames = None
         self._option_view = None
-        self._output_file = None
         self._search_results_info = None
         self._service = None
 
@@ -282,61 +281,66 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
 
         """
         self.logger.debug('%s arguments: %s' % (type(self).__name__, args))
-        self._outputfile = output_file
         self._configuration = None
 
-        if len(args) >= 2 and args[1] == '__GETINFO__':
+        try:
+            if len(args) >= 2 and args[1] == '__GETINFO__':
+
+                ConfigurationSettings, operation, args, reader = self._prepare(
+                    args, input_file=None)
 
-            ConfigurationSettings, operation, args, reader = self._prepare(
-                args, input_file=None)
-            try:
                 self.parser.parse(args, self)
-            except (SyntaxError, ValueError) as e:
-                from traceback import format_exc
-                self._exit(format_exc(), e, 1)
 
-            self._configuration = ConfigurationSettings(self)
+                self._configuration = ConfigurationSettings(self)
 
-            writer = csv.DictWriter(
-                output_file, self, self.configuration.keys(), mv_delimiter=',')
-            writer.writerow(self.configuration.items())
+                writer = csv.DictWriter(
+                    output_file, self, self.configuration.keys(), mv_delimiter=',')
+                writer.writerow(self.configuration.items())
 
-        elif len(args) >= 2 and args[1] == '__EXECUTE__':
+            elif len(args) >= 2 and args[1] == '__EXECUTE__':
 
-            self.input_header.read(input_file)
-            ConfigurationSettings, operation, args, reader = self._prepare(
-                args, input_file)
+                self.input_header.read(input_file)
+
+                ConfigurationSettings, operation, args, reader = self._prepare(
+                    args, input_file)
 
-            try:
                 self.parser.parse(args, self)
-            except (SyntaxError, ValueError) as e:
-                from traceback import format_exc
-                self._exit(format_exc(), e, 1)
 
-            self._configuration = ConfigurationSettings(self)
+                self._configuration = ConfigurationSettings(self)
 
-            if self.show_configuration:
-                self.messages.append(
-                    'info_message', '%s command configuration settings: %s'
-                    % (self.name, self._configuration))
+                if self.show_configuration:
+                    self.messages.append(
+                        'info_message', '%s command configuration settings: %s'
+                        % (self.name, self._configuration))
 
-            writer = csv.DictWriter(output_file, self)
-            self._execute(operation, reader, writer)
+                writer = csv.DictWriter(output_file, self)
+                self._execute(operation, reader, writer)
 
-        else:
+            else:
 
-            file_name = path.basename(args[0])
-            message = (
-                'Command {0} appears to be statically configured and static '
-                'configuration is unsupported by splunklib.searchcommands. '
-                'Please ensure that default/commands.conf contains this '
-                'stanza: '
-                '[{0}] | '
-                'filename = {1} | '
-                'supports_getinfo = true | '
-                'supports_rawargs = true | '
-                'outputheader = true'.format(type(self).name, file_name))
-            self._exit(message, message, 1)
+                file_name = path.basename(args[0])
+                message = (
+                    'Command {0} appears to be statically configured and static '
+                    'configuration is unsupported by splunklib.searchcommands. '
+                    'Please ensure that default/commands.conf contains this '
+                    'stanza: '
+                    '[{0}] | '
+                    'filename = {1} | '
+                    'supports_getinfo = true | '
+                    'supports_rawargs = true | '
+                    'outputheader = true'.format(type(self).name, file_name))
+                raise NotImplementedError(message)
+
+        except Exception as error:
+
+            from traceback import format_exc
+
+            writer = csv.DictWriter(output_file, self, fieldnames=['ERROR'])
+            writer.writerow({'ERROR': error})
+            self.logger.error(format_exc())
+            exit(1)
+
+        return
 
     @staticmethod
     def records(reader):
@@ -350,12 +354,6 @@ def _prepare(self, argv, input_file):
     def _execute(self, operation, reader, writer):
         raise NotImplementedError('SearchCommand._configure(self, argv)')
 
-    def _exit(self, log, error, status_code):
-        writer = csv.DictWriter(self.output_file, self, fieldnames=['ERROR'])
-        writer.writerow({'ERROR': error})
-        self.logger.error(log)
-        exit(status_code)
-
     #endregion
 
     #region Types

splunklib/searchcommands/streaming_command.py

@@ -71,12 +71,8 @@ def stream(self, records):
         raise NotImplementedError('StreamingCommand.stream(self, records)')
 
     def _execute(self, operation, reader, writer):
-        try:
-            for record in operation(SearchCommand.records(reader)):
-                writer.writerow(record)
-        except Exception as e:
-            from traceback import format_exc
-            self._exit(format_exc(), e, 1)
+        for record in operation(SearchCommand.records(reader)):
+            writer.writerow(record)
 
     def _prepare(self, argv, input_file):
         ConfigurationSettings = type(self).ConfigurationSettings