refactor:

 - add more specific init method for each framework
 - minor correct for ENABLE_JSON_LOGGING_DEBUG
 - update code comments

Author: bobbui

README.md

@@ -31,7 +31,7 @@ Install by running this command:
 
 By default log will be emitted in normal format to ease the local development. To enable it on production set either **json_logging.ENABLE_JSON_LOGGING** or **ENABLE_JSON_LOGGING environment variable** to true.
 
-To configure, call **json_logging.init(framework_name)**. Once configured library will try to configure all loggers (existing and newly created) to emit log in JSON format.   
+To configure, call **json_logging.init_< framework_name >()**. Once configured library will try to configure all loggers (existing and newly created) to emit log in JSON format.   
 See following use cases for more detail.
 
 TODO: update guide on how to use ELK stack to view log  
@@ -43,7 +43,7 @@ import json_logging, logging, sys
 
 # log is initialized without a web framework name
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init()
+json_logging.init_non_web()
 
 logger = logging.getLogger("test-logger")
 logger.setLevel(logging.DEBUG)
@@ -60,7 +60,7 @@ import datetime, logging, sys, json_logging, flask
 
 app = flask.Flask(__name__)
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='flask')
+json_logging.init_flask()
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -83,7 +83,7 @@ import logging, sys, json_logging, sanic
 
 app = sanic.Sanic()
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='sanic')
+json_logging.init_sanic()
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -107,7 +107,7 @@ import asyncio, logging, sys, json_logging, quart
 
 app = quart.Quart(__name__)
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='quart')
+json_logging.init_quart()
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -133,7 +133,7 @@ import datetime, logging, sys, json_logging, connexion
 
 app = connexion.FlaskApp(__name__)
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='connexion', specification_dir='openapi/')
+json_logging.init_connexion()
 json_logging.init_request_instrument(app)
 
 app.add_api('api.yaml')
@@ -163,8 +163,7 @@ Extra property can be added to logging statement as follow:
 logger.info("test log statement", extra = {'props' : {'extra_property' : 'extra_value'}})
 ```
 ## 2.5 Root logger
-If you want to use root logger as main logger to emit log. Made sure you call **config_root_logger()** after initialize root logger (by
-logging.basicConfig() or logging.getLogger('root')) [\[2\]](#2-python-logging-propagate)
+If you want to use root logger as main logger to emit log. Made sure you call **config_root_logger()** after initialize root logger (by logging.basicConfig() or logging.getLogger('root')) [\[2\]](#2-python-logging-propagate)
 ```python
 logging.basicConfig()
 json_logging.config_root_logger()

example/connexion-example/hello.py

@@ -11,7 +11,7 @@ def post_greeting(name: str) -> str:
 def create():
     app = connexion.FlaskApp(__name__, port=9090, specification_dir='openapi/')
     json_logging.ENABLE_JSON_LOGGING = True
-    json_logging.init(framework_name='connexion')
+    json_logging.init_connexion()
     json_logging.init_request_instrument(app)
 
     app.add_api('helloworld-api.yaml', arguments={'title': 'Hello World Example'})

example/custom_log_format.py

@@ -56,7 +56,7 @@ def format(self, record):
 
 
 def logger_init():
-    json_logging.init(custom_formatter=CustomJSONLog)
+    json_logging.__init(custom_formatter=CustomJSONLog)
 
 # You would normally import logger_init and setup the logger in your main module - e.g.
 # main.py

example/flask_sample_app.py

@@ -7,8 +7,7 @@
 
 app = flask.Flask(__name__)
 json_logging.ENABLE_JSON_LOGGING = True
-# json_logging.CREATE_CORRELATION_ID_IF_NOT_EXISTS = False
-json_logging.init(framework_name='flask')
+json_logging.init_flask()
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -35,4 +34,4 @@ def exception():
 
 
 if __name__ == "__main__":
-    app.run(host='0.0.0.0', port=int(5000), use_reloader=True)
+    app.run(host='0.0.0.0', port=int(5000), use_reloader=False)

example/non_web.py

@@ -5,7 +5,7 @@
 
 # log is initialized without a web framework name
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init()
+json_logging.init_non_web()
 
 logger = logging.getLogger("test logger")
 logger.setLevel(logging.DEBUG)

example/quart_sample_app.py

@@ -8,7 +8,7 @@
 
 app = quart.Quart(__name__)
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='quart')
+json_logging.init_quart()
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -26,4 +26,4 @@ async def home():
 
 if __name__ == "__main__":
     loop = asyncio.get_event_loop()
-    app.run(host='0.0.0.0', port=int(5000), use_reloader=False, loop=loop)
+    app.run(host='0.0.0.0', port=int(5001), use_reloader=False, loop=loop)

example/sanic_sample_app.py

@@ -6,7 +6,7 @@
 
 app = sanic.Sanic()
 json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init(framework_name='sanic')
+json_logging.__init(framework_name='sanic')
 json_logging.init_request_instrument(app)
 
 # init the logger as usual

json_logging/__init__.py

@@ -62,7 +62,7 @@ def register_framework_support(name, app_configurator, app_request_instrumentati
 
     name = name.lower()
     if name in _framework_support_map:
-        _logger.warning("Re-register framework %s", name)
+        ENABLE_JSON_LOGGING_DEBUG and _logger.warning("Re-register framework %s", name)
     _framework_support_map[name] = {
         'app_configurator': app_configurator,
         'app_request_instrumentation_configurator': app_request_instrumentation_configurator,
@@ -75,10 +75,11 @@ def config_root_logger():
     """
         You must call this if you are using root logger.
         Make all root logger' handlers produce JSON format
-        & remove duplicate handlers for request instrumentation logging
+        & remove duplicate handlers for request instrumentation logging.
+        Please made sure that you call this after you called "logging.basicConfig() or logging.getLogger('root')
     """
     if ENABLE_JSON_LOGGING:
-        _logger.debug("Update root logger to using JSONLogFormatter")
+        ENABLE_JSON_LOGGING_DEBUG and _logger.debug("Update root logger to using JSONLogFormatter")
         if len(logging.root.handlers) > 0:
             if _current_framework is not None or _current_framework != '-':
                 util.update_formatter_for_loggers([logging.root], JSONLogWebFormatter)
@@ -95,7 +96,11 @@ def config_root_logger():
                 "logging.basicConfig() or logging.getLogger('root')")
 
 
-def init(framework_name=None, custom_formatter=None):
+def init_non_web():
+    __init()
+
+
+def __init(framework_name=None, custom_formatter=None):
     """
     Initialize JSON logging support, if no **framework_name** passed, logging will be initialized in non-web context.
     This is supposed to be called only one time.
@@ -110,12 +115,16 @@ def init(framework_name=None, custom_formatter=None):
     if _current_framework is not None:
         raise RuntimeError("Can not call init more than once")
 
-    _logger.info("init framework " + str(framework_name))
+    if custom_formatter:
+        if not issubclass(custom_formatter, logging.Formatter):
+            raise ValueError('custom_formatter is not subclass of logging.Formatter', custom_formatter)
+
+    ENABLE_JSON_LOGGING_DEBUG and _logger.info("init framework " + str(framework_name))
 
     if framework_name:
         framework_name = framework_name.lower()
         if framework_name not in _framework_support_map.keys():
-            raise RuntimeError(framework_name + "is not a supported framework")
+            raise RuntimeError(framework_name + " is not a supported framework")
 
         _current_framework = _framework_support_map[framework_name]
         global _request_util
@@ -125,23 +134,19 @@ def init(framework_name=None, custom_formatter=None):
         if ENABLE_JSON_LOGGING and _current_framework['app_configurator'] is not None:
             _current_framework['app_configurator']().config()
 
-        formatter = JSONLogWebFormatter
-    elif custom_formatter:
-        if not issubclass(custom_formatter, logging.Formatter):
-            raise ValueError('custom_formatter is not subclass of logging.Formatter', custom_formatter)
-        formatter = custom_formatter
+        formatter = custom_formatter if custom_formatter else JSONLogWebFormatter
     else:
-        formatter = JSONLogFormatter
+        formatter = custom_formatter if custom_formatter else JSONLogFormatter
 
     if not ENABLE_JSON_LOGGING:
         _logger.warning(
-            "JSON format is not enable! "
+            "JSON format is not enable, normal log will be in plain text but request logging still in JSON format! "
             "To enable set ENABLE_JSON_LOGGING env var to either one of following values: ['true', '1', 'y', 'yes']")
     else:
         logging._defaultFormatter = formatter()
 
     # go to all the initialized logger and update it to use JSON formatter
-    _logger.debug("Update all existing logger to using JSONLogFormatter")
+    ENABLE_JSON_LOGGING_DEBUG and _logger.debug("Update all existing logger to using JSONLogFormatter")
     existing_loggers = list(map(logging.getLogger, logging.Logger.manager.loggerDict))
     util.update_formatter_for_loggers(existing_loggers, formatter)
 
@@ -327,7 +332,12 @@ def format(self, record):
                            flask_support.FlaskRequestAdapter,
                            flask_support.FlaskResponseAdapter)
 
-# register flask support
+
+def init_flask(custom_formatter=None):
+    __init(framework_name='flask', custom_formatter=custom_formatter)
+
+
+# register sanic support
 # noinspection PyPep8
 from json_logging.framework.sanic import SanicAppConfigurator, SanicAppRequestInstrumentationConfigurator, \
     SanicRequestAdapter, SanicResponseAdapter
@@ -337,18 +347,32 @@ def format(self, record):
                            SanicRequestAdapter,
                            SanicResponseAdapter)
 
+
+def init_sanic(custom_formatter=None):
+    __init(framework_name='sanic', custom_formatter=custom_formatter)
+
+
 # register quart support
 # noinspection PyPep8
 import json_logging.framework.quart as quart_support
 
 register_framework_support('quart', None, quart_support.QuartAppRequestInstrumentationConfigurator,
-                        quart_support.QuartRequestAdapter,
-                        quart_support.QuartResponseAdapter)
+                           quart_support.QuartRequestAdapter,
+                           quart_support.QuartResponseAdapter)
+
+
+def init_quart(custom_formatter=None):
+    __init(framework_name='quart', custom_formatter=custom_formatter)
+
 
 # register connexion support
 # noinspection PyPep8
 import json_logging.framework.connexion as connexion_support
 
 register_framework_support('connexion', None, connexion_support.ConnexionAppRequestInstrumentationConfigurator,
-                        connexion_support.ConnexionRequestAdapter,
-                        connexion_support.ConnexionResponseAdapter)
+                           connexion_support.ConnexionRequestAdapter,
+                           connexion_support.ConnexionResponseAdapter)
+
+
+def init_connexion(custom_formatter=None):
+    __init(framework_name='connexion', custom_formatter=custom_formatter)

json_logging/framework/flask/__init__.py

@@ -4,7 +4,6 @@
 
 import json_logging
 import json_logging.framework
-from json_logging import JSONLogWebFormatter
 from json_logging.framework_base import AppRequestInstrumentationConfigurator, RequestAdapter, ResponseAdapter
 
 
@@ -36,7 +35,8 @@ def config(self, app):
         # Disable standard logging
         logging.getLogger('werkzeug').disabled = True
 
-        json_logging.util.update_formatter_for_loggers([logging.getLogger('werkzeug')], JSONLogWebFormatter)
+        json_logging.util.update_formatter_for_loggers([logging.getLogger('werkzeug')],
+                                                       json_logging.JSONLogWebFormatter)
 
         # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('flask-request-logger')

json_logging/util.py

@@ -25,11 +25,10 @@ def get_library_logger(logger_name):
         return logging.getLogger(logger_name)
 
     logger = logging.getLogger(logger_name)
-    if json_logging.ENABLE_JSON_LOGGING_DEBUG:
-        logger.setLevel(logging.DEBUG)
-        # add stdout output in case parent have no handlers
-        if len(logger.parent.handlers) == 0:
-            logger.addHandler(StreamHandler(sys.stdout))
+    logger.setLevel(logging.DEBUG)
+    # add stdout output in case parent have no handlers
+    if len(logger.parent.handlers) == 0:
+        logger.addHandler(StreamHandler(sys.stdout))
 
     return logger