Added optional stack trace to exception logging. Issue 1268

Author: stevrobu

aws_lambda_powertools/logging/formatter.py

@@ -5,10 +5,14 @@
 import logging
 import os
 import time
+import traceback
 from abc import ABCMeta, abstractmethod
 from datetime import datetime, timezone
 from functools import partial
 from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Union
+from ..shared.functions import (
+    resolve_truthy_env_var_choice
+)
 
 from aws_lambda_powertools.logging.types import LogRecord
 from aws_lambda_powertools.shared import constants
@@ -77,6 +81,7 @@ def __init__(
         log_record_order: List[str] | None = None,
         utc: bool = False,
         use_rfc3339: bool = False,
+        include_traceback: bool = None,
         **kwargs,
     ) -> None:
         """Return a LambdaPowertoolsFormatter instance.
@@ -148,16 +153,34 @@ def __init__(
         self.keys_combined = {**self._build_default_keys(), **kwargs}
         self.log_format.update(**self.keys_combined)
 
+        self.include_traceback = resolve_truthy_env_var_choice(env=os.getenv(constants.POWERTOOLS_TRACEBACK_ENV, "false"),
+                                                               choice=include_traceback,
+                                                               )
+
         super().__init__(datefmt=self.datefmt)
 
     def serialize(self, log: LogRecord) -> str:
         """Serialize structured log dict to JSON str"""
         return self.json_serializer(log)
+    
+    def serialize_traceback(self, e: Exception) -> list:
+        return [{"File": fs.filename, 
+                    "Line": fs.lineno,
+                    "Column": fs.colno,
+                    "Function": fs.name,
+                    "Statement": fs.line
+                    } for fs in traceback.extract_tb(e.__traceback__)]
+
 
     def format(self, record: logging.LogRecord) -> str:  # noqa: A003
         """Format logging record as structured JSON str"""
         formatted_log = self._extract_log_keys(log_record=record)
         formatted_log["message"] = self._extract_log_message(log_record=record)
+
+        if self.include_traceback:
+            # Generate the traceback from the traceback library
+            formatted_log["stack_trace"] = self.serialize_traceback(record.msg) #JSR
+
         # exception and exception_name fields can be added as extra key
         # in any log level, we try to extract and use them first
         extracted_exception, extracted_exception_name = self._extract_log_exception(log_record=record)

aws_lambda_powertools/shared/constants.py

@@ -42,3 +42,5 @@
 
 POWERTOOLS_DEV_ENV: str = "POWERTOOLS_DEV"
 POWERTOOLS_DEBUG_ENV: str = "POWERTOOLS_DEBUG"
+
+POWERTOOLS_TRACEBACK_ENV: str = "POWERTOOLS_LOGGER_ENHANCED_TRACEBACK"