unexpected log entry when logging configured with dictConfig fix #51

Author: Bob Bui

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).  
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 1.2.4 - 2020-08-03
+ - fix #51
+
 ## 1.2.2 - 2020-07-14
  - fix #50
 

README.md

@@ -30,7 +30,7 @@ If you're using Cloud Foundry, it might worth to check out the library [SAP/cf-p
 Install by running this command:
    > pip install json-logging  
 
-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.
+By default log will be emitted in normal format to ease the local development. To enable it on production set enable_json in init_\<framework name\>(enable_json=True) method call (set **json_logging.ENABLE_JSON_LOGGING** or **ENABLE_JSON_LOGGING environment variable** to true is not recommended and will be deprecated in future versions).
 
 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.
@@ -41,8 +41,7 @@ This mode don't support **correlation-id**.
 import json_logging, logging, sys
 
 # log is initialized without a web framework name
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_non_web()
+json_logging.init_non_web(enable_json=True)
 
 logger = logging.getLogger("test-logger")
 logger.setLevel(logging.DEBUG)
@@ -183,6 +182,7 @@ logger.info("test log statement", extra = {'props' : {'extra_property' : 'extra_
 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.init_<framework name >()
 json_logging.config_root_logger()
 ```
 
@@ -196,7 +196,6 @@ logging library can be configured by setting the value in json_logging, all conf
 Name | Description | Default value
  --- | --- | ---
 ENABLE_JSON_LOGGING | **DEPRECATED** Whether to enable JSON logging mode.Can be set as an environment variable, enable when set to to either one in following list (case-insensitive) **['true', '1', 'y', 'yes']** , this have no effect on request logger | false
-ENABLE_JSON_LOGGING_DEBUG |  Whether to enable debug logging for this library for development purpose. | true
 CORRELATION_ID_HEADERS | List of HTTP headers that will be used to look for correlation-id value. HTTP headers will be searched one by one according to list order| ['X-Correlation-ID','X-Request-ID']
 EMPTY_VALUE | Default value when a logging record property is None |  '-'
 CORRELATION_ID_GENERATOR | function to generate unique correlation-id | uuid.uuid1

example/non_web.py

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

json_logging/__init__.py

@@ -82,23 +82,15 @@ def config_root_logger():
     """
     global _default_formatter
 
+    if len(logging.root.handlers) > 0:
+        _logger.error(
+            "No logging handlers found for root logger. Please made sure that you call this after you called "
+            "logging.basicConfig() or logging.getLogger('root')")
+
     if ENABLE_JSON_LOGGING:
         ENABLE_JSON_LOGGING_DEBUG and _logger.debug("Update root logger to using JSONLogFormatter")
 
-        if len(logging.root.handlers) > 0:
-            if _current_framework is None or _current_framework == '-':
-                util.update_formatter_for_loggers([logging.root], _default_formatter)
-            else:
-                util.update_formatter_for_loggers([logging.root], _default_formatter)
-                # remove all handlers for request logging
-                request_logger = _current_framework['app_request_instrumentation_configurator']().get_request_logger()
-                if request_logger:
-                    for handler in request_logger.handlers:
-                        request_logger.removeHandler(handler)
-        else:
-            _logger.error(
-                "No logging handlers found for root logger. Please made sure that you call this after you called "
-                "logging.basicConfig() or logging.getLogger('root')")
+        util.update_formatter_for_loggers([logging.root], _default_formatter)
 
 
 def init_non_web(*args, **kw):
@@ -119,6 +111,7 @@ def __init(framework_name=None, custom_formatter=None, enable_json=False):
     global _current_framework
     global ENABLE_JSON_LOGGING
     global _default_formatter
+    ENABLE_JSON_LOGGING = enable_json
     if _current_framework is not None:
         raise RuntimeError("Can not call init more than once")
 
@@ -184,6 +177,7 @@ def init_request_instrument(app=None, custom_formatter=None):
     request_logger.setLevel(logging.DEBUG)
     request_logger.addHandler(logging.StreamHandler(sys.stdout))
     util.update_formatter_for_loggers([request_logger], formatter)
+    request_logger.parent = None
 
 
 def get_request_logger():

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name="json-logging",
-    version='1.2.2',
+    version='1.2.4',
     packages=find_packages(exclude=['contrib', 'docs', 'tests*', 'example', 'dist', 'build']),
     license='Apache License 2.0',
     description="JSON Python Logging",