splunklib.searchcommands.logging update

- Updated probing path for logging configuration file
- Updated logging.conf files to prevent creation of the file referenced in the file handler section
  The Python logger creates all files fully realizes all logging handler, whether they're used or not.

Author: David Noble

examples/searchcommands_app/default/app.conf

@@ -10,7 +10,7 @@ author = Splunk
 version = 1.0
 
 [package]
-id = custom_search_commands
+id = searchcommands_app
 
 [install]
 is_configured = 1

examples/searchcommands_app/default/logging.conf

@@ -2,32 +2,26 @@
 keys = root, CountMatchesCommand, SimulateCommand, SumCommand
 
 [logger_root]
-level = DEBUG   ; Default: WARNING
+level = DEBUG     ; Default: WARNING
 handlers = stderr ; Default: stderr
 
 [logger_CountMatchesCommand]
 qualname = CountMatchesCommand
-level = NOTSET   ; Default: WARNING
+level = NOTSET    ; Default: WARNING
 handlers = stderr ; Default: stderr
 
 [logger_SimulateCommand]
 qualname = SimulateCommand
-level = NOTSET   ; Default: WARNING
+level = NOTSET    ; Default: WARNING
 handlers = stderr ; Default: stderr
 
 [logger_SumCommand]
 qualname = SumCommand
-level = NOTSET   ; Default: WARNING
+level = NOTSET    ; Default: WARNING
 handlers = stderr ; Default: stderr
 
 [handlers]
-keys=file, stderr
-
-[handler_file]
-class = logging.FileHandler
-level = NOTSET
-args = ('custom_search_commands.log',)
-formatter = search_command
+keys=stderr
 
 [handler_stderr]
 class = logging.StreamHandler

examples/searchcommands_scaffolding/default/logging.conf

@@ -11,13 +11,7 @@ level = WARNING         ; Default: WARNING
 handlers = stderr       ; Default: stderr
 
 [handlers]
-keys=file, stderr
-
-[handler_file]
-class = logging.FileHandler
-level = NOTSET
-args = ('%(app_id).log',)
-formatter = search_command
+keys=stderr
 
 [handler_stderr]
 class = logging.StreamHandler

splunklib/searchcommands/logging.py

@@ -43,14 +43,24 @@ def configure(cls, path=None):
     The current directory is reset to its previous value before this function
     returns.
 
+    #Arguments:
+
     :param cls: Class contained in <app-root>/bin/<module>.py
+    :type cls: type
     :param path: Location of an alternative logging configuration file or `None`
+    :type path: str or NoneType
 
     """
+    logger_name = cls.__name__
     module = inspect.getmodule(cls)
     app_directory = os.path.dirname(os.path.dirname(module.__file__))
     if path is None:
-        for relative_path in 'local/logging.conf', 'default/logging.conf':
+        probing_path = [
+            'local/%s.logging.conf' % logger_name,
+            'default/%s.logging.conf' % logger_name,
+            'local/logging.conf',
+            'default/logging.conf']
+        for relative_path in probing_path:
             configuration_file = os.path.join(app_directory, relative_path)
             if os.path.exists(configuration_file):
                 path = configuration_file
@@ -63,5 +73,5 @@ def configure(cls, path=None):
             fileConfig(path)
         finally:
             os.chdir(working_directory)
-    logger = getLogger(cls.__name__)
+    logger = getLogger(logger_name)
     return logger, path