allow to print out the trace messages directly on the command line

per default, only the messages from server start/server stop process are
printed out directly on the command line. All other traces are
redirected to a specified log file.
With this changes, if no log file name is specified all traces will be
printed out on the CLI.

Author: Helene

source/bridgeLogger.py

@@ -52,10 +52,7 @@ def configureLogging(logPath, logfile, loglevel=logging.INFO):
     except (ValueError, TypeError):
         loglevel = logging.INFO
 
-    # create the logfile path if needed
-    if not os.path.exists(logPath):
-        os.makedirs(logPath)
-    logfile = os.path.join(logPath, logfile)
+    logToFile = True if logfile else False
 
     formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)-8s - %(message)s')
     formatter1 = logging.Formatter('%(asctime)s - %(levelname)-8s - %(message)s', datefmt='%Y-%m-%d %H:%M')
@@ -65,15 +62,25 @@ def configureLogging(logPath, logfile, loglevel=logging.INFO):
     logger = logging.getLogger(__name__)
     logger.setLevel(logging.TRACE)
 
+    # prepare stream handler
     strmhandler = logging.StreamHandler()
-    strmhandler.setLevel(logging.INFO)
+    strmhandler.setLevel(loglevel)
     strmhandler.setFormatter(formatter1)
 
-    rfhandler = logging.handlers.RotatingFileHandler(logfile, 'a', 1000000, 5)  # 5 x 1M files
-    rfhandler.setLevel(loglevel)
-    rfhandler.setFormatter(formatter)
+    if logToFile:
+        # create the log file path if needed
+        if not os.path.exists(logPath):
+            os.makedirs(logPath)
+        logfile = os.path.join(logPath, logfile)
+
+        rfhandler = logging.handlers.RotatingFileHandler(logfile, 'a', 1000000, 5)  # 5 x 1M files
+        rfhandler.setLevel(loglevel)
+        rfhandler.setFormatter(formatter)
+
+        strmhandler.setLevel(logging.INFO)  # if we log to a file limit the console traces to INFO level
+
+        logger.addHandler(rfhandler)
 
-    logger.addHandler(rfhandler)
     logger.addHandler(strmhandler)
 
     logger.propagate = False  # prevent propagation to default (console) logger

source/confParser.py

@@ -177,7 +177,8 @@ def parse_cmd_args(argv):
     parser.add_argument('-P', '--serverPort', action="store", type=int, choices=[9980, 9981], default=None,
                         help='ZIMon collector port number (Default from config.ini: 9980)')
     parser.add_argument('-l', '--logPath', action="store", default=None, help='location path of the log file (Default from config.ini: \'/var/log/ibm_bridge_for_grafana\')')
-    parser.add_argument('-f', '--logFile', action="store", default=None, help='Name of the log file (Default from config.ini: zserver.log')
+    parser.add_argument('-f', '--logFile', action="store", default=None, help='Name of the log file (Default from config.ini: zserver.log). If no log file name specified \
+    all traces will be printed out directly on the command line')
     parser.add_argument('-c', '--logLevel', action="store", type=int, default=None,
                         help='log level. Available levels: 10 (DEBUG), 15 (MOREINFO), 20 (INFO), 30 (WARN), 40 (ERROR) (Default from config.ini: 15)')
     parser.add_argument('-p', '--port', action="store", type=int, choices=[4242, 8443], default=None, help='port number listening on for HTTP(S) connections (Default from config.ini: 4242)')

source/config.ini

@@ -45,4 +45,5 @@ logPath = /var/log/ibm_bridge_for_grafana
 logLevel = 15
 
 # Log file name (Default: zserver.log)
+# Comment out this setting, if you wish to print out the trace messages directly on the command line
 logFile = zserver.log

source/zimonGrafanaIntf.py

@@ -588,7 +588,7 @@ def main(argv):
         return
 
     # prepare the logger
-    logger = configureLogging(args.get('logPath'), args.get('logFile'), args.get('logLevel'))
+    logger = configureLogging(args.get('logPath'), args.get('logFile', None), args.get('logLevel'))
 
     # prepare cherrypy server configuration
     updateCherrypyConf(args)

tests/test_logger.py

@@ -14,5 +14,20 @@ def test_case02():
 
 
 def test_case03():
+    with assert_raises(TypeError):
+        configureLogging(None, 'myLog')
+
+
+def test_case04():
     result = configureLogging('/tmp', 'mylog', 'abc')
     assert isinstance(result, logging.Logger)
+
+
+def test_case05():
+    result = configureLogging('/tmp', None, 'abc')
+    assert isinstance(result, logging.Logger)
+
+
+def test_case06():
+    result = configureLogging('/tmp', None)
+    assert isinstance(result, logging.Logger)