add formatter for logs and update README.md file

- add default time and log formatter in setup_logging() method
- add details of setup_logging() method and logging.conf files in README.md file

Author: akaila-splunk

README.md

@@ -243,6 +243,19 @@ class GeneratorTest(GeneratingCommand):
         checkpoint_dir = inputs.metadata["checkpoint_dir"]
 ```
 
+#### Optional:Set up logging for splunklib
++ The default level is WARNING, which means that only events of this level and above will be visible
++ To change a logging level we can call setup_logging() method and pass the logging level as an argument.
++ Optional: we can also pass log format and date format string as a method argument to modify default format
+
+```python
+import logging
+from splunklib import setup_logging
+
+# To see debug and above level logs
+setup_logging(logging.DEBUG)
+```
+
 ### Changelog
 
 The [CHANGELOG](CHANGELOG.md) contains a description of changes for each version of the SDK. For the latest version, see the [CHANGELOG.md](https://github.com/splunk/splunk-sdk-python/blob/master/CHANGELOG.md) on GitHub.

examples/searchcommands_app/README.md

@@ -35,7 +35,7 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
     └── default.meta ............. Permits the search assistant to use searchbnf.conf[6]
 ```
 **References**  
-[1] [app.conf](https://docs.splunk.com/Documentation/Splunk/latest/Admin/Appconf app.conf)  
+[1] [app.conf](https://docs.splunk.com/Documentation/Splunk/latest/Admin/Appconf)  
 [2] [commands.conf](https://docs.splunk.com/Documentation/Splunk/latest/Admin/Commandsconf)  
 [3] [Python Logging HOWTO](https://docs.python.org/2/howto/logging.html)  
 [4] [ConfigParser—Configuration file parser](https://docs.python.org/2/library/configparser.html)
@@ -110,6 +110,15 @@ word_counts |
 :-----|
 4497.0 |
 
+## Optional:Set up logging using logging.conf file
++ Inside the **default** directory of our app, we have a [logging.conf](https://github.com/splunk/splunk-sdk-python/blob/master/examples/searchcommands_app/package/default/logging.conf) file.
++ In logging.conf file we can define loggers, handlers and formatters for our app. refer [this doc](https://docs.python.org/2/library/logging.config.html#configuration-file-format) for more details
++ Logs will be written in the files specified in the handlers defined for the respective loggers
+  + For **'searchcommands_app'** app logs will be written in **searchcommands_app.log** and **splunklib.log** files defined in respective handlers, and are present at $SPLUNK_HOME/etc/apps/searchcommands_app/ dir
+  + By default logs will be written in the app's root directory, but it can be overriden by specifying the absolute path for the logs file in the conf file
++ By default, logging level is set to WARNING
++ To see debug and above level logs, Set level to DEBUG in logging.conf file
+
 ## License
 
 This software is licensed under the Apache License 2.0. Details can be found in

examples/searchcommands_app/package/default/logging.conf

@@ -96,3 +96,4 @@ keys = searchcommands
 
 [formatter_searchcommands]
 format = %(asctime)s, Level=%(levelname)s, Pid=%(process)s, Logger=%(name)s, File=%(filename)s, Line=%(lineno)s, %(message)s
+datefmt = %Y-%m-%d %H:%M:%S %Z

splunklib/__init__.py

@@ -18,11 +18,18 @@
 from splunklib.six.moves import map
 import logging
 
+DEFAULT_LOG_FORMAT = '%(asctime)s, Level=%(levelname)s, Pid=%(process)s, Logger=%(name)s, File=%(filename)s, ' \
+                 'Line=%(lineno)s, %(message)s'
+DEFAULT_DATE_FORMAT = '%Y-%m-%d %H:%M:%S %Z'
+
+
 # To set the logging level of splunklib
 # ex. To enable debug logs, call this method with parameter 'logging.DEBUG'
 # default logging level is set to 'WARNING'
-def setLoggingLevel(level):
-    logging.basicConfig(level=level)
+def setup_logging(level, log_format=DEFAULT_LOG_FORMAT, date_format=DEFAULT_DATE_FORMAT):
+    logging.basicConfig(level=level,
+                        format=log_format,
+                        datefmt=date_format)
 
 __version_info__ = (1, 6, 18)
 __version__ = ".".join(map(str, __version_info__))