Add global context for logger

Author: AttilaGombosER

.github/workflows/ci.yaml

@@ -2,11 +2,11 @@ name: CI
 
 on:
   push:
-    branches: [main]
-    tags: [v*.*.*]
+    branches: [ main ]
+    tags: [ v*.*.* ]
 
   pull_request:
-    branches: [ "main" ]
+    branches: [ main ]
     types:
       - synchronize
       - opened

context_logger/filter.py

@@ -5,14 +5,16 @@
 import socket
 from importlib.metadata import version, PackageNotFoundError
 from logging import Filter, LogRecord
+from typing import Any
 
 
 class ContextSetupFilter(Filter):
 
-    def __init__(self, application_name: str, message_field: str):
+    def __init__(self, application_name: str, message_field: str, global_context: dict[str, Any] | None = None):
         super().__init__()
         self._application_name = application_name
         self._message_field = message_field
+        self._global_context = global_context if global_context else {}
 
     def filter(self, record: LogRecord) -> bool:
         try:
@@ -26,6 +28,11 @@ def filter(self, record: LogRecord) -> bool:
 
             if 'process_name' in record.msg:
                 record.msg['process_name'] = record.processName
+
+            for key, value in self._global_context.items():
+                if key not in record.msg:
+                    record.msg[key] = str(value)
+
         except Exception as exception:
             print('Failed to handle log record:', exception)
 

context_logger/logger.py

@@ -27,7 +27,8 @@ def get_logger(logger_name: str) -> Any:
 
 def setup_logging(application_name: str, log_level: str = 'INFO',
                   log_file_path: Optional[str] = None, max_bytes: int = 1024 * 1024, backup_count: int = 5,
-                  add_call_info: bool = False, warn_on_overwrite: bool = True, message_field: str = 'message') -> None:
+                  add_call_info: bool = False, warn_on_overwrite: bool = True, message_field: str = 'message',
+                  global_context: dict[str, Any] | None = None) -> None:
     global LOGGER
 
     if LOGGER:
@@ -36,22 +37,25 @@ def setup_logging(application_name: str, log_level: str = 'INFO',
 
         LOGGER.cleanup()
 
-    LOGGER = Logger(application_name, log_level, log_file_path, max_bytes, backup_count, add_call_info, message_field)
+    LOGGER = Logger(application_name, log_level, log_file_path, max_bytes, backup_count, add_call_info, message_field,
+                    global_context)
 
     LOGGER.setup()
 
 
 class Logger(object):
 
     def __init__(self, application_name: str, log_level: str, log_file_path: Optional[str], max_bytes: int,
-                 backup_count: int, add_call_info: bool, message_field: str) -> None:
+                 backup_count: int, add_call_info: bool, message_field: str,
+                 global_context: dict[str, Any] | None = None) -> None:
         self._application_name = application_name
         self._log_level = logging.getLevelName(log_level.upper())
         self._log_file_path = log_file_path
         self._max_bytes = max_bytes
         self._backup_count = backup_count
-        self._message_field = message_field
         self._add_call_info = add_call_info
+        self._message_field = message_field
+        self._global_context = global_context
         self._handlers: list[Handler] = []
 
     def setup(self) -> None:
@@ -131,7 +135,7 @@ def _create_console_handler(self) -> Handler:
 
         handler = logging.StreamHandler(sys.stdout)
         handler.setFormatter(formatter)
-        handler.addFilter(ContextSetupFilter(self._application_name, self._message_field))
+        handler.addFilter(ContextSetupFilter(self._application_name, self._message_field, self._global_context))
 
         return handler
 
@@ -146,7 +150,7 @@ def _create_file_handler(self, log_file_path: str) -> RotatingFileHandler:
 
         handler = RotatingFileHandler(log_file_path, maxBytes=self._max_bytes, backupCount=self._backup_count)
         handler.setFormatter(formatter)
-        handler.addFilter(ContextSetupFilter(self._application_name, self._message_field))
+        handler.addFilter(ContextSetupFilter(self._application_name, self._message_field, self._global_context))
 
         return handler
 

tests/loggerTest.py

@@ -19,7 +19,7 @@ def setUp(self):
 
     def test_structlog_logging(self):
         # Given
-        setup_logging('example-app', warn_on_overwrite=False)
+        setup_logging('example-app', warn_on_overwrite=False, global_context={'global1': 'value1'})
 
         log = get_logger('ExampleClass')
 
@@ -36,7 +36,7 @@ def test_structlog_logging(self):
 
     def test_stdlib_logging(self):
         # Given
-        setup_logging('example-app', warn_on_overwrite=False)
+        setup_logging('example-app', warn_on_overwrite=False, global_context={'global1': 'value1'})
 
         stdlib_log = logging.getLogger('ExampleClass')
 
@@ -54,7 +54,8 @@ def test_file_logging(self):
         # Given
         log_file_path = f'{TESTS_DIR_PATH}/logs/example.log'
         shutil.rmtree(os.path.dirname(log_file_path), ignore_errors=True)
-        setup_logging('example-app', 'INFO', log_file_path, add_call_info=True, warn_on_overwrite=False)
+        setup_logging('example-app', 'INFO', log_file_path, add_call_info=True, warn_on_overwrite=False,
+                      global_context={'global1': 'value1'})
 
         log = get_logger('ExampleClass')
         stdlib_log = logging.getLogger('ExampleClass')
@@ -82,6 +83,7 @@ def test_file_logging(self):
             self.assertEqual('This is an error message', log_entry.get('message'))
             self.assertEqual('Something terrible happened', log_entry.get('error_message'))
             self.assertEqual(1234, log_entry.get('error_code'))
+            self.assertEqual('value1', log_entry.get('global1'))
             self.assertIsNotNone(log_entry.get('pathname'))
             self.assertIsNotNone(log_entry.get('func_name'))
             self.assertIsNotNone(log_entry.get('lineno'))
@@ -99,7 +101,8 @@ def test_overwriting_setup(self):
         stdlib_log = logging.getLogger('ExampleClass')
 
         # When
-        setup_logging('example-app', 'ERROR', log_file_path, add_call_info=False, message_field='msg')
+        setup_logging('example-app', 'ERROR', log_file_path, add_call_info=False, message_field='msg',
+                      global_context={'global1': 'value1'})
 
         log.info('This is a simple message')
         stdlib_log.error('This is an error message')
@@ -115,6 +118,7 @@ def test_overwriting_setup(self):
             self.assertEqual('This is an error message', log_entry.get('msg'))
             self.assertEqual('Something terrible happened', log_entry.get('error_message'))
             self.assertEqual(1234, log_entry.get('error_code'))
+            self.assertEqual('value1', log_entry.get('global1'))
             self.assertIsNone(log_entry.get('pathname'))
             self.assertIsNone(log_entry.get('func_name'))
             self.assertIsNone(log_entry.get('lineno'))