chore: add color to jormungandr logs by default

Author: vgeof-hove

source/jormungandr/jormungandr/default_settings.py

@@ -5,6 +5,7 @@
 import json
 from flask_restful.inputs import boolean
 from datetime import timedelta
+import logging
 
 # sql queries will return an exception if the query did not succeed before `statement_timeout`
 DEFAULT_SQLALCHEMY_ENGINE_OPTIONS = {
@@ -51,28 +52,28 @@
 log_level = os.getenv('JORMUNGANDR_LOG_LEVEL', 'DEBUG')
 log_format = os.getenv(
     'JORMUNGANDR_LOG_FORMAT',
-    '[%(asctime)s] [%(request_id)s] [%(levelname)5s] [%(process)5s] [%(name)10s] %(message)s',
+     "%(time_colored)s %(level_colored)s %(name_colored)s %(request_colored)s %(message)s",
 )
 log_formatter = os.getenv('JORMUNGANDR_LOG_FORMATTER', 'default')  # default or json
 log_extras = json.loads(os.getenv('JORMUNGANDR_LOG_EXTRAS', '{}'))  # fields to add to the logger
 
 
 access_log_format = os.getenv(
     'JORMUNGANDR_ACCESS_LOG_FORMAT',
-    '[%(asctime)s] [%(request_id)s] [%(process)5s] [%(name)10s] %(message)s',
+    '%(time_colored)s %(level_colored)s %(name_colored)s %(request_colored)s %(message)s',
 )
 access_log_formatter = os.getenv('JORMUNGANDR_ACCESS_LOG_FORMATTER', 'access_log')
 
 logfmt_keys = json.loads(os.getenv('JORMUNGANDR_LOG_LOGFMT_KEYS', '[]'))
 logfmt_mapping = json.loads(os.getenv('JORMUNGANDR_LOG_LOGFMT_MAPPING', '{}'))
 
-# logger configuration
+ # logger configuration
 LOGGER = {
     'version': 1,
     'disable_existing_loggers': False,
     'formatters': {
-        'default': {'format': log_format},
-        'access_log': {'format': access_log_format},
+        'default': {'()': 'jormungandr.logging_utils.ColorFormatter','format':log_format},
+        'access_log': {'()': 'jormungandr.logging_utils.ColorFormatter','format': access_log_format},
         'json': {
             '()': 'jormungandr.logging_utils.CustomJsonFormatter',
             'format': log_format,

source/jormungandr/jormungandr/logging_utils.py

@@ -57,3 +57,28 @@ def __init__(self, *args, **kwargs):
     def process_log_record(self, log_record):
         log_record.update(self.extras)
         return log_record
+
+class ColorFormatter(logging.Formatter):
+    RESET = "\033[0m"
+
+    COLORS = {
+        "time": "\033[2m",      # gris léger
+        "level_DEBUG": "\033[36m",
+        "level_INFO": "\033[32m",
+        "level_WARNING": "\033[33m",
+        "level_ERROR": "\033[31m",
+        "level_CRITICAL": "\033[41m",
+        "name": "\033[90m",     # magenta
+        "request": "\033[34m",  # bleu
+    }
+
+    def format(self, record):
+        level_color = self.COLORS.get(f"level_{record.levelname}", "")
+
+        record.level_colored = f"{level_color}{record.levelname:<5}{self.RESET}"
+        record.time_colored = f"{self.COLORS['time']}{self.formatTime(record)}{self.RESET}"
+        record.name_colored = f"{self.COLORS['name']}{record.name}{self.RESET}"
+        request_id = getattr(record, "request_id", "-")
+        record.request_colored = f"{self.COLORS['request']}{request_id}{self.RESET}"
+
+        return super().format(record)