Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

fix(backend): keep the traceback when a TruncatedLogger call passes exc_info (#15351)

Reinier van der Leer75e5a9ada410
diff --git a/autogpt_platform/backend/backend/util/logging.py b/autogpt_platform/backend/backend/util/logging.py
index ce574e25f6..1a9c40a0b1 100644
--- a/autogpt_platform/backend/backend/util/logging.py
+++ b/autogpt_platform/backend/backend/util/logging.py
@@ -36,6 +36,9 @@ def is_structured_logging_enabled() -> bool:
)
+_LOGGING_KWARGS = ("exc_info", "stack_info", "stacklevel")
+
+
class TruncatedLogger:
def __init__(
self,
@@ -50,24 +53,26 @@ class TruncatedLogger:
self.prefix = prefix
def info(self, msg: str, **extra):
- msg = self._wrap(msg, **extra)
- self.logger.info(msg, extra=self._get_metadata(**extra))
+ self._log(self.logger.info, msg, extra)
def warning(self, msg: str, **extra):
- msg = self._wrap(msg, **extra)
- self.logger.warning(msg, extra=self._get_metadata(**extra))
+ self._log(self.logger.warning, msg, extra)
def error(self, msg: str, **extra):
- msg = self._wrap(msg, **extra)
- self.logger.error(msg, extra=self._get_metadata(**extra))
+ self._log(self.logger.error, msg, extra)
def debug(self, msg: str, **extra):
- msg = self._wrap(msg, **extra)
- self.logger.debug(msg, extra=self._get_metadata(**extra))
+ self._log(self.logger.debug, msg, extra)
def exception(self, msg: str, **extra):
- msg = self._wrap(msg, **extra)
- self.logger.exception(msg, extra=self._get_metadata(**extra))
+ self._log(self.logger.exception, msg, extra)
+
+ def _log(self, log, msg: str, extra: dict):
+ # logging's own arguments go to logging; as metadata they lose the traceback.
+ kwargs = {key: extra.pop(key) for key in _LOGGING_KWARGS if key in extra}
+ # Skip this frame and the level method, so the record names the caller.
+ kwargs["stacklevel"] = kwargs.get("stacklevel", 1) + 2
+ log(self._wrap(msg, **extra), extra=self._get_metadata(**extra), **kwargs)
def _get_metadata(self, **extra):
metadata = {**self.metadata, **extra}
diff --git a/autogpt_platform/backend/backend/util/logging_test.py b/autogpt_platform/backend/backend/util/logging_test.py
new file mode 100644
index 0000000000..0fde41bc45
--- /dev/null
+++ b/autogpt_platform/backend/backend/util/logging_test.py
@@ -0,0 +1,46 @@
+import logging
+
+import pytest
+
+from backend.util.logging import TruncatedLogger
+
+
[email protected]("level", ["debug", "info", "warning", "error", "exception"])
+def test_truncated_logger_hands_exc_info_to_logging(level, caplog):
+ base = logging.getLogger(f"truncated_logger_test.{level}")
+ logger = TruncatedLogger(base, prefix="[Test]")
+ try:
+ raise ValueError("kaput")
+ except ValueError as e:
+ error = e
+
+ with caplog.at_level(logging.DEBUG, logger=base.name):
+ getattr(logger, level)("failed", exc_info=error, user_id="u1")
+
+ (record,) = caplog.records
+ assert record.exc_info is not None and record.exc_info[1] is error
+ assert "Traceback" in caplog.text
+ assert record.getMessage() == "[Test] failed {'user_id': 'u1'}"
+ assert record.__dict__["json_fields"] == {"user_id": "u1"}
+
+
[email protected]("level", ["debug", "info", "warning", "error", "exception"])
+def test_truncated_logger_records_its_callers_location(level, caplog):
+ logger = TruncatedLogger(logging.getLogger(f"truncated_logger_test.at.{level}"))
+
+ with caplog.at_level(logging.DEBUG, logger=logger.logger.name):
+ _log_here(logger, level)
+ _log_one_level_up(logger, level)
+
+ assert [(r.funcName, r.lineno) for r in caplog.records] == [
+ ("_log_here", _log_here.__code__.co_firstlineno + 1),
+ ("_log_one_level_up", _log_one_level_up.__code__.co_firstlineno + 1),
+ ]
+
+
+def _log_here(logger: TruncatedLogger, level: str, **kwargs):
+ getattr(logger, level)("logged", **kwargs)
+
+
+def _log_one_level_up(logger: TruncatedLogger, level: str):
+ _log_here(logger, level, stacklevel=2)