- fix #45

 - fix #46
 - refactoring
 - optimization log record

Author: bobbui

CHANGELOG.md

@@ -4,6 +4,12 @@ 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.0 - 2020-04-10
+ - fix #45
+ - fix #46
+ - refactoring
+ - optimization log record
+
 ## 1.1.0 - 2020-04-10
  - Add the possibility to modify the formatter for request logs.
 

README.md

@@ -21,9 +21,9 @@ If you're using Cloud Foundry, it worth to check out the library [SAP/cf-python-
 1. Emit JSON logs ([format detail](#0-full-logging-format-references))
 2. Auto extract **correlation-id** for distributed tracing [\[1\]](#1-what-is-correlation-idrequest-id)
 3. Lightweight, no dependencies, minimal configuration needed (1 LoC to get it working)
-4. Fully compatible with Python **logging** module. Support both Python 2.7.x and 3.x
+4. Seamlessly integrate with Python native **logging** module. Support both Python 2.7.x and 3.x
 5. Support HTTP request instrumentation. Built in support for [Flask](https://github.com/pallets/flask/), [Sanic](https://github.com/channelcat/sanic), [Quart](https://gitlab.com/pgjones/quart), [Connexion](https://github.com/zalando/connexion). Extensible to support other web frameworks. PR welcome :smiley: .
-6. Support inject arbitrary extra properties to JSON log message.  
+6. Highly customizable: support inject arbitrary extra properties to JSON log message, override logging formatter, etc.  
 
 # 2. Usage
 Install by running this command:
@@ -59,8 +59,7 @@ logger.info("test logging statement")
 import datetime, logging, sys, json_logging, flask
 
 app = flask.Flask(__name__)
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_flask()
+json_logging.init_flask(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -71,6 +70,8 @@ logger.addHandler(logging.StreamHandler(sys.stdout))
 @app.route('/')
 def home():
     logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
     return "Hello world : " + str(datetime.datetime.now())
 
 if __name__ == "__main__":
@@ -81,9 +82,8 @@ if __name__ == "__main__":
 ```python
 import logging, sys, json_logging, sanic
 
-app = sanic.Sanic()
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_sanic()
+app = sanic.Sanic(name="sanic-web-app")
+json_logging.init_sanic(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -94,6 +94,12 @@ logger.addHandler(logging.StreamHandler(sys.stdout))
 @app.route("/")
 async def home(request):
     logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    # this will be faster
+    correlation_id = json_logging.get_correlation_id(request=request)
+    # this will be slower, but will work in context you cant get a reference of request object
+    correlation_id_without_request_obj = json_logging.get_correlation_id()
+
     return sanic.response.text("hello world")
 
 if __name__ == "__main__":
@@ -106,8 +112,7 @@ if __name__ == "__main__":
 import asyncio, logging, sys, json_logging, quart
 
 app = quart.Quart(__name__)
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_quart()
+json_logging.init_quart(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -118,7 +123,8 @@ logger.addHandler(logging.StreamHandler(sys.stdout))
 @app.route('/')
 async def home():
     logger.info("test log statement")
-    logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
     return "Hello world"
 
 if __name__ == "__main__":
@@ -129,11 +135,10 @@ if __name__ == "__main__":
 ### Connexion
 
 ```python
-import datetime, logging, sys, json_logging, connexion
+import logging, sys, json_logging, connexion
 
 app = connexion.FlaskApp(__name__)
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_connexion()
+json_logging.init_connexion(enable_json=True)
 json_logging.init_request_instrument(app)
 
 app.add_api('api.yaml')
@@ -151,7 +156,10 @@ if __name__ == "__main__":
 Current request correlation-id can be retrieved and pass to downstream services call as follow:
 
 ```python
-correlation_id = json_logging.get_correlation_id()
+# this will be faster
+correlation_id = json_logging.get_correlation_id(request=request)
+# this will be slower, but will work in context where you couldn't get a reference of request object
+correlation_id_without_request_obj = json_logging.get_correlation_id()
 # use correlation id for downstream service calls here
 ```
 
@@ -178,7 +186,7 @@ logging library can be configured by setting the value in json_logging, all conf
 
 Name | Description | Default value
  --- | --- | ---
-ENABLE_JSON_LOGGING | 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 | **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 |  '-'
@@ -198,7 +206,7 @@ To add support for a new web framework, you need to extend following classes in
 
 Class | Description | Mandatory
 --- | --- | ---
-RequestAdapter | Helper class help to extract logging-relevant information from HTTP request object | no
+RequestAdapter | Helper class help to extract logging-relevant information from HTTP request object | yes
 ResponseAdapter | Helper class help to extract logging-relevant information from HTTP response object | yes
 FrameworkConfigurator |  Class to perform logging configuration for given framework as needed | no
 AppRequestInstrumentationConfigurator | Class to perform request instrumentation logging configuration | no
@@ -236,7 +244,7 @@ e.g.:
 	"written_ts": 1514048137280721000,
 	"component_id": "1d930c0xd-19-s3213",
 	"component_name": "ny-component_name",
-	"component_instance": 0,
+	"component_instance_idx": 0,
 	"logger": "test logger",
 	"thread": "MainThread",
 	"level": "INFO",
@@ -256,7 +264,7 @@ e.g.:
 	"written_ts": 1514048137280721000,
 	"component_id": "-",
 	"component_name": "-",
-	"component_instance": 0,
+	"component_instance_idx": 0,
 	"correlation_id": "1975a02e-e802-11e7-8971-28b2bd90b19a",
 	"remote_user": "user_a",
 	"request": "/index.html",
@@ -287,7 +295,7 @@ correlation_id | The timestamp in nano-second precision when this request metric
 type | Type of logging. "logs" or "request"  | string |
 component_id | Uniquely identifies the software component that has processed the current request | string | 9e6f3ecf-def0-4baf-8fac-9339e61d5645
 component_name | A human-friendly name representing the software component | string | my-fancy-component
-component_instance | Instance's index of horizontally scaled service  | string | 0
+component_instance_idx | Instance's index of horizontally scaled service  | string | 0
 
 - application logs
 
@@ -352,6 +360,7 @@ password=
 build
 ```bash
 python setup.py bdist_wheel --universal
+python setup.py sdist --universal
 ```
 
 pypitest
@@ -361,6 +370,6 @@ pip3 install json_logging --index-url https://test.pypi.org/simple/
 ```
 pypi
 ```
-twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
-pip3 install json_logging
+pip3 install json_loggingtwine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+
 ```

example/connexion-example/hello.py

@@ -4,14 +4,13 @@
 import json_logging
 
 
-def post_greeting(name: str) -> str:
+def post_greeting(name):
     return 'Hello {name}'.format(name=name)
 
 
 def create():
     app = connexion.FlaskApp(__name__, port=9090, specification_dir='openapi/')
-    json_logging.ENABLE_JSON_LOGGING = True
-    json_logging.init_connexion()
+    json_logging.init_connexion(enable_json=True)
     json_logging.init_request_instrument(app)
 
     app.add_api('helloworld-api.yaml', arguments={'title': 'Hello World Example'})

example/connexion-example/openapi/helloworld-api.yaml

@@ -8,7 +8,7 @@ servers:
 
 paths:
   /greeting/{name}:
-    post:
+    get:
       summary: Generate greeting
       description: Generates a greeting message.
       operationId: hello.post_greeting

example/custom_log_format.py

@@ -19,13 +19,13 @@ class CustomJSONLog(logging.Formatter):
     """
     Customized logger
     """
-    python_log_prefix = 'python.'
+
     def get_exc_fields(self, record):
         if record.exc_info:
             exc_info = self.format_exception(record.exc_info)
         else:
             exc_info = record.exc_text
-        return {f'{self.python_log_prefix}exc_info': exc_info}
+        return {'python.exc_info': exc_info}
 
     @classmethod
     def format_exception(cls, exc_info):
@@ -38,13 +38,13 @@ def format(self, record):
                            "caller": record.filename + '::' + record.funcName
                            }
         json_log_object['data'] = {
-            f'{self.python_log_prefix}logger_name': record.name,
-            f'{self.python_log_prefix}module': record.module,
-            f'{self.python_log_prefix}funcName': record.funcName,
-            f'{self.python_log_prefix}filename': record.filename,
-            f'{self.python_log_prefix}lineno': record.lineno,
-            f'{self.python_log_prefix}thread': f'{record.threadName}[{record.thread}]',
-            f'{self.python_log_prefix}pid': record.process
+            "python.logger_name": record.name,
+            "python.module": record.module,
+            "python.funcName": record.funcName,
+            "python.filename": record.filename,
+            "python.lineno": record.lineno,
+            "python.thread": record.threadName,
+            "python.pid": record.process
         }
         if hasattr(record, 'props'):
             json_log_object['data'].update(record.props)
@@ -55,20 +55,17 @@ def format(self, record):
         return json.dumps(json_log_object)
 
 
-def logger_init():
-    json_logging.__init(custom_formatter=CustomJSONLog)
-
 # You would normally import logger_init and setup the logger in your main module - e.g.
 # main.py
 
-logger_init()
+json_logging.init_non_web(custom_formatter=CustomJSONLog)
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
 logger.addHandler(logging.StreamHandler(sys.stderr))
 
 logger.info('Starting')
 try:
-    1/0
-except: # noqa pylint: disable=bare-except
+    1 / 0
+except:  # noqa pylint: disable=bare-except
     logger.exception('You can\'t divide by zero')

example/flask_sample_app.py

@@ -6,8 +6,7 @@
 import json_logging
 
 app = flask.Flask(__name__)
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_flask()
+json_logging.init_flask(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -19,8 +18,10 @@
 @app.route('/')
 def home():
     logger.info("test log statement")
-    logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
-    return "Hello world"
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
+    return "hello world" \
+           "\ncorrelation_id                    : " + correlation_id
 
 
 @app.route('/exception')

example/non_web.py

@@ -12,4 +12,4 @@
 logger.addHandler(logging.StreamHandler(sys.stdout))
 
 logger.info("test log statement")
-logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
+logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})

example/quart_sample_app.py

@@ -7,8 +7,7 @@
 import json_logging
 
 app = quart.Quart(__name__)
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.init_quart()
+json_logging.init_quart(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -20,8 +19,10 @@
 @app.route('/')
 async def home():
     logger.info("test log statement")
-    logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
-    return "Hello world"
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
+    return "hello world" \
+           "\ncorrelation_id                    : " + correlation_id
 
 
 if __name__ == "__main__":

example/requirements.txt

@@ -1,3 +1,4 @@
 flask==1.0
-sanic==0.7.0
-Quart==0.6.7
+connexion[swagger-ui]
+quart
+sanic

example/sanic_sample_app.py

@@ -1,12 +1,13 @@
+#!/usr/bin/env python3
+
 import json_logging
 import logging
 # noinspection PyPackageRequirements
 import sanic
 import sys
 
-app = sanic.Sanic()
-json_logging.ENABLE_JSON_LOGGING = True
-json_logging.__init(framework_name='sanic')
+app = sanic.Sanic(name="sanic-web-app")
+json_logging.init_sanic(enable_json=True)
 json_logging.init_request_instrument(app)
 
 # init the logger as usual
@@ -15,13 +16,19 @@
 logger.addHandler(logging.StreamHandler(sys.stdout))
 
 
-# noinspection PyUnusedLocal
 @app.route("/")
-async def test(request):
+def test(request):
     logger.info("test log statement")
-    logger.info("test log statement", extra={'props': {"extra_property": 'extra_value'}})
-    # noinspection PyUnresolvedReferences
-    return sanic.response.text("hello world")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    # this will be faster
+    correlation_id = json_logging.get_correlation_id(request=request)
+    # this will be slower, but will work in context you cant get a reference of request object
+    correlation_id_without_request_obj = json_logging.get_correlation_id()
+
+    return sanic.response.text(
+        "hello world"
+        "\ncorrelation_id                    : " + correlation_id +
+        "\ncorrelation_id_without_request_obj: " + correlation_id_without_request_obj)
 
 
 if __name__ == "__main__":

json_logging/__init__.py

@@ -1,6 +1,7 @@
 # coding=utf-8
 import json
 import logging
+import sys
 import uuid
 from datetime import datetime
 import traceback
@@ -30,14 +31,14 @@
 _request_util = None
 
 
-def get_correlation_id():
+def get_correlation_id(request=None):
     """
     Get current request correlation-id. If one is not present, a new one might be generated
     depends on CREATE_CORRELATION_ID_IF_NOT_EXISTS setting value.
 
     :return: correlation-id string
     """
-    return _request_util.get_correlation_id()
+    return _request_util.get_correlation_id(request=request)
 
 
 def register_framework_support(name, app_configurator, app_request_instrumentation_configurator, request_adapter_class,
@@ -96,11 +97,11 @@ def config_root_logger():
                 "logging.basicConfig() or logging.getLogger('root')")
 
 
-def init_non_web(**kwargs):
-    __init(**kwargs)
+def init_non_web(*args, **kw):
+    __init(*args, **kw)
 
 
-def __init(framework_name=None, custom_formatter=None):
+def __init(framework_name=None, custom_formatter=None, enable_json=False):
     """
     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.
@@ -112,6 +113,7 @@ def __init(framework_name=None, custom_formatter=None):
     """
 
     global _current_framework
+    global ENABLE_JSON_LOGGING
     if _current_framework is not None:
         raise RuntimeError("Can not call init more than once")
 
@@ -138,11 +140,12 @@ def __init(framework_name=None, custom_formatter=None):
     else:
         formatter = custom_formatter if custom_formatter else JSONLogFormatter
 
-    if not ENABLE_JSON_LOGGING:
+    if not enable_json and not ENABLE_JSON_LOGGING:
         _logger.warning(
             "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:
+        ENABLE_JSON_LOGGING = True
         logging._defaultFormatter = formatter()
 
     # go to all the initialized logger and update it to use JSON formatter
@@ -163,7 +166,7 @@ def init_request_instrument(app=None, custom_formatter=None):
 
     if _current_framework is None or _current_framework == '-':
         raise RuntimeError("please init the logging first, call init(framework_name) first")
-    
+
     if custom_formatter:
         if not issubclass(custom_formatter, logging.Formatter):
             raise ValueError('custom_formatter is not subclass of logging.Formatter', custom_formatter)
@@ -172,8 +175,10 @@ def init_request_instrument(app=None, custom_formatter=None):
     configurator.config(app)
 
     formatter = custom_formatter if custom_formatter else JSONRequestLogFormatter
-    logger = configurator.request_logger
-    util.update_formatter_for_loggers([logger], formatter)
+    request_logger = configurator.request_logger
+    request_logger.setLevel(logging.DEBUG)
+    request_logger.addHandler(logging.StreamHandler(sys.stdout))
+    util.update_formatter_for_loggers([request_logger], formatter)
 
 
 def get_request_logger():
@@ -197,7 +202,7 @@ class that keep HTTP request information for request instrumentation logging
     """
 
     def __init__(self, request, **kwargs):
-        super(self.__class__, self).__init__(**kwargs)
+        super(RequestInfo, self).__init__(**kwargs)
         utcnow = datetime.utcnow()
         self.request_start = utcnow
         self.request = request
@@ -223,20 +228,29 @@ class BaseJSONFormatter(logging.Formatter):
     """
        Base class for JSON formatters
     """
+    base_object_common = {}
+
+    def __init__(self, *args, **kw):
+        super(BaseJSONFormatter, self).__init__(*args, **kw)
+        if COMPONENT_ID and COMPONENT_ID != EMPTY_VALUE:
+            self.base_object_common["component_id"] = COMPONENT_ID
+        if COMPONENT_NAME and COMPONENT_NAME != EMPTY_VALUE:
+            self.base_object_common["component_name"] = COMPONENT_NAME
+        if COMPONENT_INSTANCE_INDEX and COMPONENT_INSTANCE_INDEX != EMPTY_VALUE:
+            self.base_object_common["component_instance_idx"] = COMPONENT_INSTANCE_INDEX
 
     def format(self, record):
         log_object = self._format_log_object(record, request_util=_request_util)
         return JSON_SERIALIZER(log_object)
 
     def _format_log_object(self, record, request_util):
         utcnow = datetime.utcnow()
-        return {
+        base_obj = {
             "written_at": util.iso_time_format(utcnow),
             "written_ts": util.epoch_nano_second(utcnow),
-            "component_id": COMPONENT_ID,
-            "component_name": COMPONENT_NAME,
-            "component_instance": COMPONENT_INSTANCE_INDEX,
         }
+        base_obj.update(self.base_object_common)
+        return base_obj
 
 
 class JSONRequestLogFormatter(BaseJSONFormatter):
@@ -245,7 +259,7 @@ class JSONRequestLogFormatter(BaseJSONFormatter):
     """
 
     def _format_log_object(self, record, request_util):
-        json_log_object = super()._format_log_object(record, request_util)
+        json_log_object = super(JSONRequestLogFormatter, self)._format_log_object(record, request_util)
         request = record.request_info.request
         request_adapter = request_util.request_adapter
 
@@ -271,7 +285,6 @@ def _format_log_object(self, record, request_util):
             "response_sent_at": record.request_info.response_sent_at
         })
         return json_log_object
-        
 
 
 def _sanitize_log_msg(record):
@@ -298,15 +311,15 @@ def format_exception(cls, exc_info):
         return ''.join(traceback.format_exception(*exc_info)) if exc_info else ''
 
     def _format_log_object(self, record, request_util):
-        json_log_object = super()._format_log_object(record, request_util)
+        json_log_object = super(JSONLogFormatter, self)._format_log_object(record, request_util)
         json_log_object.update({
+            "msg": _sanitize_log_msg(record),
             "type": "log",
             "logger": record.name,
             "thread": record.threadName,
             "level": record.levelname,
             "module": record.module,
             "line_no": record.lineno,
-            "msg": _sanitize_log_msg(record),
         })
         if hasattr(record, 'props'):
             json_log_object.update(record.props)
@@ -323,9 +336,9 @@ class JSONLogWebFormatter(JSONLogFormatter):
     """
 
     def _format_log_object(self, record, request_util):
-        json_log_object = super()._format_log_object(record, request_util)
+        json_log_object = super(JSONLogWebFormatter, self)._format_log_object(record, request_util)
         json_log_object.update({
-            "correlation_id": request_util.get_correlation_id(),
+            "correlation_id": request_util.get_correlation_id(within_formatter=True),
         })
         return json_log_object
 
@@ -339,8 +352,8 @@ def _format_log_object(self, record, request_util):
                            flask_support.FlaskResponseAdapter)
 
 
-def init_flask(custom_formatter=None):
-    __init(framework_name='flask', custom_formatter=custom_formatter)
+def init_flask(custom_formatter=None, enable_json=False):
+    __init(framework_name='flask', custom_formatter=custom_formatter, enable_json=enable_json)
 
 
 # register sanic support
@@ -354,8 +367,8 @@ def init_flask(custom_formatter=None):
                            SanicResponseAdapter)
 
 
-def init_sanic(custom_formatter=None):
-    __init(framework_name='sanic', custom_formatter=custom_formatter)
+def init_sanic(custom_formatter=None, enable_json=False):
+    __init(framework_name='sanic', custom_formatter=custom_formatter, enable_json=enable_json)
 
 
 # register quart support
@@ -367,8 +380,8 @@ def init_sanic(custom_formatter=None):
                            quart_support.QuartResponseAdapter)
 
 
-def init_quart(custom_formatter=None):
-    __init(framework_name='quart', custom_formatter=custom_formatter)
+def init_quart(custom_formatter=None, enable_json=False):
+    __init(framework_name='quart', custom_formatter=custom_formatter, enable_json=enable_json)
 
 
 # register connexion support
@@ -380,5 +393,5 @@ def init_quart(custom_formatter=None):
                            connexion_support.ConnexionResponseAdapter)
 
 
-def init_connexion(custom_formatter=None):
-    __init(framework_name='connexion', custom_formatter=custom_formatter)
+def init_connexion(custom_formatter=None, enable_json=False):
+    __init(framework_name='connexion', custom_formatter=custom_formatter, enable_json=enable_json)

json_logging/framework/connexion/__init__.py

@@ -44,8 +44,7 @@ def config(self, app):
 
         # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('connexion-request-logger')
-        self.request_logger.setLevel(logging.DEBUG)
-        self.request_logger.addHandler(logging.StreamHandler(sys.stdout))
+
 
         from flask import g
 
@@ -81,9 +80,6 @@ def get_remote_user(self, request):
         else:
             return json_logging.EMPTY_VALUE
 
-    def is_in_request_context(self, request_):
-        return _flask.has_request_context()
-
     def get_http_header(self, request, header_name, default=None):
         if header_name in request.headers:
             return request.headers.get(header_name)

json_logging/framework/flask/__init__.py

@@ -40,8 +40,6 @@ def config(self, app):
 
         # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('flask-request-logger')
-        self.request_logger.setLevel(logging.DEBUG)
-        self.request_logger.addHandler(logging.StreamHandler(sys.stdout))
 
         from flask import g
 
@@ -77,9 +75,6 @@ def get_remote_user(self, request):
         else:
             return json_logging.EMPTY_VALUE
 
-    def is_in_request_context(self, request_):
-        return _flask.has_request_context()
-
     def get_http_header(self, request, header_name, default=None):
         if header_name in request.headers:
             return request.headers.get(header_name)

json_logging/framework/quart/__init__.py

@@ -45,8 +45,6 @@ def config(self, app):
 
         # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('quart.app')
-        self.request_logger.setLevel(logging.DEBUG)
-        self.request_logger.addHandler(logging.StreamHandler(sys.stdout))
 
         from quart import g
 
@@ -82,9 +80,6 @@ def get_remote_user(self, request):
         else:
             return json_logging.EMPTY_VALUE
 
-    def is_in_request_context(self, request_):
-        return _quart.has_request_context()
-
     def get_http_header(self, request, header_name, default=None):
         if header_name in request.headers:
             return request.headers.get(header_name)

json_logging/framework/sanic/__init__.py

@@ -1,5 +1,7 @@
 # coding=utf-8
 import logging
+import logging.config
+
 import sys
 
 import json_logging
@@ -26,14 +28,16 @@ def config(self):
 
         # from sanic.config import LOGGING
         # noinspection PyPackageRequirements
-        from sanic.log import LOGGING_CONFIG_DEFAULTS as LOGGING
+        from sanic.log import LOGGING_CONFIG_DEFAULTS
+
+        LOGGING_CONFIG_DEFAULTS['disable_existing_loggers'] = False
+        LOGGING_CONFIG_DEFAULTS['formatters']['generic']['class'] = "json_logging.JSONLogFormatter"
+        del LOGGING_CONFIG_DEFAULTS['formatters']['generic']['format']
 
-        LOGGING['disable_existing_loggers'] = False
-        LOGGING['formatters']['generic']['class'] = "json_logging.JSONLogFormatter"
-        del LOGGING['formatters']['generic']['format']
+        LOGGING_CONFIG_DEFAULTS['formatters']['access']['class'] = "json_logging.JSONLogFormatter"
+        del LOGGING_CONFIG_DEFAULTS['formatters']['access']['format']
 
-        LOGGING['formatters']['access']['class'] = "json_logging.JSONLogFormatter"
-        del LOGGING['formatters']['access']['format']
+        # logging.config.dictConfig(LOGGING_CONFIG_DEFAULTS)
 
 
 class SanicAppRequestInstrumentationConfigurator(AppRequestInstrumentationConfigurator):
@@ -47,8 +51,8 @@ def config(self, app):
 
         # noinspection PyAttributeOutsideInit
         self.request_logger = logging.getLogger('sanic-request')
-        self.request_logger.setLevel(logging.DEBUG)
-        self.request_logger.addHandler(logging.StreamHandler(sys.stdout))
+
+        logging.getLogger('sanic.access').disabled = True
 
         @app.middleware('request')
         def before_request(request):
@@ -70,9 +74,6 @@ class SanicRequestAdapter(RequestAdapter):
     def get_current_request():
         raise NotImplementedError
 
-    def is_in_request_context(self, request):
-        return request is not None
-
     @staticmethod
     def support_global_request_object():
         return False

json_logging/framework_base.py

@@ -12,7 +12,7 @@ def __new__(cls, *arg, **kwargs):
     @staticmethod
     def support_global_request_object():
         """
-            whether current framework supports global request object
+            whether current framework supports global request object like Flask
         """
         raise NotImplementedError
 
@@ -26,7 +26,7 @@ def get_current_request():
     @staticmethod
     def get_request_class_type():
         """
-            class type of request object
+            class type of request object, only need to specify in case the framework dont support global request object
         """
         raise NotImplementedError
 
@@ -48,13 +48,6 @@ def get_remote_user(self, request):
         """
         raise NotImplementedError
 
-    def is_in_request_context(self, request):
-        """
-
-        :param request: request object
-        """
-        raise NotImplementedError
-
     def set_correlation_id(self, request, value):
         """
         We can safely assume that request is valid request object.\n
@@ -166,7 +159,7 @@ def get_content_type(self, response):
 
 class FrameworkConfigurator:
     """
-       Class to perform logging configuration for given framework as needed
+       Class to perform logging configuration for given framework as needed, like disable built in request logging and other utils logging
     """
 
     def __new__(cls, *args, **kw):

json_logging/util.py

@@ -6,6 +6,7 @@
 from logging import Logger, StreamHandler
 
 import json_logging
+import inspect
 
 
 def is_env_var_toggle(var_name):
@@ -82,13 +83,11 @@ def iso_time_format(datetime_):
         int(datetime_.microsecond / 1000))
 
 
-_no_of_go_up_level = 11
 if hasattr(sys, '_getframe'):
-    # noinspection PyProtectedMember,PyPep8
-    currentframe = lambda: sys._getframe(_no_of_go_up_level)
+    currentframe = lambda _no_of_go_up_level: sys._getframe(_no_of_go_up_level)
 else:  # pragma: no cover
     # noinspection PyBroadException
-    def currentframe():
+    def currentframe(_no_of_go_up_level):
         """Return the frame object for the caller's stack frame."""
         try:
             raise Exception
@@ -105,9 +104,12 @@ def __new__(cls, *args, **kw):
         if not hasattr(cls, '_instance'):
             request_adapter_class = kw['request_adapter_class']
             response_adapter_class = kw['response_adapter_class']
+
             validate_subclass(request_adapter_class, json_logging.RequestAdapter)
             validate_subclass(response_adapter_class, json_logging.ResponseAdapter)
+
             cls._instance = object.__new__(cls)
+
             cls._instance.request_adapter_class = request_adapter_class
             cls._instance.response_adapter_class = response_adapter_class
             cls._instance.request_adapter = request_adapter_class()
@@ -117,7 +119,7 @@ def __new__(cls, *args, **kw):
 
         return cls._instance
 
-    def get_correlation_id(self, request=None):
+    def get_correlation_id(self, request=None,within_formatter=False):
         """
         Gets the correlation id from the header of the request. \
         It tries to search from json_logging.CORRELATION_ID_HEADERS list, one by one.\n
@@ -133,9 +135,7 @@ def get_correlation_id(self, request=None):
             else:
                 request = self.get_request_from_call_stack()
 
-            if not self.request_adapter.is_in_request_context(request):
-                # _logger.debug("Not in request context, return %s", json_logging.EMPTY_VALUE,
-                #               extra={'correlation_id': '-'})
+            if request is None:
                 return json_logging.EMPTY_VALUE
 
         # _logger.debug("Attempt to get correlation from request context", extra={'correlation_id': '-'})
@@ -151,7 +151,7 @@ def get_correlation_id(self, request=None):
 
         return correlation_id if correlation_id else json_logging.EMPTY_VALUE
 
-    def get_request_from_call_stack(self):
+    def get_request_from_call_stack(self, within_formatter=False):
         """
 
         :return: get request object from call stack
@@ -170,11 +170,15 @@ def get_request_from_call_stack(self):
             09 info [__init__.py:1279]
             10 logging statement
         """
+        module = inspect.getmodule(inspect.currentframe().f_back)
+
+        class_type = self.request_adapter_class.get_request_class_type()
+        no_of_go_up_level = 11 if within_formatter else 1
+
         # FIXME: find out the depth of logging call stack in Python 2.7
-        f = currentframe()
+        f = currentframe(no_of_go_up_level)
         while True:
             f_locals = f.f_locals
-            class_type = self.request_adapter_class.get_request_class_type()
             if 'request' in f_locals:
                 if isinstance(f_locals['request'], class_type):
                     return f_locals['request']

setup.py

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

test-requirements.txt

@@ -1 +1,4 @@
-flask==1.0
+flask==1.0
+connexion[swagger-ui]
+quart
+sanic