fix the damn logger coloring; automatically print trace in case of exception

Author: pieroit

compose.yml

@@ -7,7 +7,7 @@ services:
     container_name: cheshire_cat_core
     # Uncomment the two lines below to use your .env (see .env.example)
     # env_file:
-    #  - .env
+    #   - .env
     ports:
       - ${CCAT_CORE_PORT:-1865}:80
       - 5678:5678 # only for development purposes (take away in production)

core/cat/log.py

@@ -4,6 +4,7 @@
 import sys
 import inspect
 import json
+import traceback
 from pprint import pformat
 from loguru import logger
 
@@ -36,8 +37,7 @@ class CatLogEngine:
         - `ERROR`
         - `CRITICAL`
 
-    Default to `INFO`.
-
+    Default to `CCAT_LOG_LEVEL` env variable (`INFO`).
     """
 
     def __init__(self):
@@ -69,11 +69,18 @@ def default_log(self):
         -------
         """
 
-        time = "<green>[{time:YYYY-MM-DD HH:mm:ss.SSS}]</green>"
-        level = "<level>{level: <6}</level>"
-        origin = "<level>{extra[original_name]}.{extra[original_class]}.{extra[original_caller]}::{extra[original_line]}</level>"
+        color = {
+            "DEBUG": "white",
+            "WARNING": "yellow",
+            "ERROR": "red",
+            "CRITICAL": "white",
+        }.get(self.LOG_LEVEL, "green")
+
+        level = f"<level>" + "{level}" + f"</level>"
+        # time = "<green>[{time:YYYY-MM-DD HH:mm:ss.SSS}]</green>"
+        # origin = "<level>{extra[original_name]}.{extra[original_class]}.{extra[original_caller]}::{extra[original_line]}</level>"
         message = "<level>{message}</level>"
-        log_format = f"{time} {level} {origin} \n{message}"
+        log_format = f"{level}\t{message}"
 
         logger.remove()
         if self.LOG_LEVEL == "DEBUG":
@@ -177,9 +184,17 @@ def error(self, msg):
         """Logs an ERROR message"""
         self.log(msg, level="ERROR")
 
+        # Only print the traceback if an exception handler is being executed
+        if sys.exc_info()[0] is not None:
+            traceback.print_exc()
+
     def critical(self, msg):
         """Logs a CRITICAL message"""
         self.log(msg, level="CRITICAL")
+        
+        # Only print the traceback if an exception handler is being executed
+        if sys.exc_info()[0] is not None:
+            traceback.print_exc()
 
     def log(self, msg, level="DEBUG"):
         """Log a message
@@ -191,15 +206,6 @@ def log(self, msg, level="DEBUG"):
         level : str
             Logging level."""
 
-        (package, module, klass, caller, line) = self.get_caller_info()
-
-        custom_logger = logger.bind(
-            original_name=f"{package}.{module}",
-            original_line=line,
-            original_class=klass,
-            original_caller=caller,
-        )
-
         # prettify
         if type(msg) in [dict, list, str]:  # TODO: should be recursive
             try:
@@ -210,7 +216,9 @@ def log(self, msg, level="DEBUG"):
             msg = pformat(msg)
 
         # actual log
-        custom_logger.log(level, msg)
+        lines = msg.split("\n")
+        for l in lines:
+            logger.log(level, l)
 
     def welcome(self):
         """Welcome message in the terminal."""
@@ -228,6 +236,19 @@ def welcome(self):
         print(f"\n\n{left_margin} Cat REST API:   {cat_address}/docs")
         print(f"{left_margin} Cat ADMIN:      {cat_address}/admin\n\n")
 
+        self.log_examples()
+
+
+    def log_examples(self):
+
+        """Log examples for the log engine."""
+        for c in [self, "Hello there!", [1, 4, "sdfsf"], {"a": 1, "b": {"c": 2}}]:
+            self.debug(c)
+            self.info(c)
+            self.warning(c)
+            self.error(c)
+            self.critical(c)
+            
 
 # logger instance
 log = CatLogEngine()

core/cat/looking_glass/stray_cat.py

@@ -631,7 +631,6 @@ def classify(
 "{sentence}" -> """
 
         response = self.llm(prompt)
-        log.info(response)
 
         # find the closest match and its score with levenshtein distance
         best_label, score = min(

core/cat/looking_glass/white_rabbit.py

@@ -23,7 +23,7 @@ class WhiteRabbit:
     """
 
     def __init__(self):
-        log.info("Initializing WhiteRabbit...")
+        log.debug("Initializing WhiteRabbit...")
 
         # Where the jobs are stored. We can also use an external db to have persistence
         jobstores = {"default": MemoryJobStore()}
@@ -50,12 +50,12 @@ def __init__(self):
             self._job_ended_listener, EVENT_JOB_EXECUTED | EVENT_JOB_ERROR
         )
 
-        log.info("WhiteRabbit: Starting scheduler")
+        log.debug("WhiteRabbit: Starting scheduler")
 
         # Start the scheduler
         try:
             self.scheduler.start()
-            log.info("WhiteRabbit: Scheduler started")
+            log.debug("WhiteRabbit: Scheduler started")
         except Exception as e:
             log.error("WhiteRabbit: Error during scheduler start: ", e)
 

core/cat/mad_hatter/mad_hatter.py

@@ -101,8 +101,7 @@ def find_plugins(self):
             f"{self.plugins_folder}*/"
         )
 
-        log.info("ACTIVE PLUGINS:")
-        log.info(self.active_plugins)
+        log.info(f"Active Plugins: {self.active_plugins}")
 
         # discover plugins, folder by folder
         for folder in all_plugin_folders: