Updated the tests, serialization method and renamed the parameter

Author: stevrobu

.gitignore

@@ -252,6 +252,7 @@ dmypy.json
 .pyre/
 
 ### VisualStudioCode ###
+.vscode
 .vscode/*
 !.vscode/tasks.json
 !.vscode/launch.json

aws_lambda_powertools/logging/formatter.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import sys
 import json
 import logging
 import os
@@ -81,7 +82,7 @@ def __init__(
         log_record_order: List[str] | None = None,
         utc: bool = False,
         use_rfc3339: bool = False,
-        include_stacktrace: bool = None,
+        serialize_stacktrace: bool = None,
         **kwargs,
     ) -> None:
         """Return a LambdaPowertoolsFormatter instance.
@@ -153,8 +154,8 @@ def __init__(
         self.keys_combined = {**self._build_default_keys(), **kwargs}
         self.log_format.update(**self.keys_combined)
 
-        self.include_stacktrace = resolve_truthy_env_var_choice(env=os.getenv(constants.POWERTOOLS_STACKTRACE_ENV, "false"),
-                                                               choice=include_stacktrace,
+        self.serialize_stacktrace = resolve_truthy_env_var_choice(env=os.getenv(constants.POWERTOOLS_STACKTRACE_ENV, "false"),
+                                                               choice=serialize_stacktrace,
                                                                )
 
         super().__init__(datefmt=self.datefmt)
@@ -163,27 +164,44 @@ 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 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 serialize_traceback(self, log_record: logging.LogRecord) -> list:
+        exception_info = {
+            "type": log_record.exc_info[0].__name__,
+            "value": log_record.exc_info[1],
+            "module": log_record.exc_info[1].__class__.__module__,
+            "frames": []
+        }
+
+        exception_info["frames"] = [{
+                "file": fs.filename,
+                "line": fs.lineno,
+                "function": fs.name,
+                "statement": fs.line
+            } for fs in traceback.extract_tb(log_record.exc_info[2])]
 
+        return exception_info
 
     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_stacktrace:
+        if self.serialize_stacktrace:
             # Generate the traceback from the traceback library
-            formatted_log["stack_trace"] = self.serialize_traceback(record.msg) #JSR
+            formatted_log["stack_trace"] = self.serialize_traceback(log_record=record)
 
         # 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)
+        formatted_log["record"] = record
         formatted_log["exception"] = formatted_log.get("exception", extracted_exception)
         formatted_log["exception_name"] = formatted_log.get("exception_name", extracted_exception_name)
         formatted_log["xray_trace_id"] = self._get_latest_trace_id()

aws_lambda_powertools/logging/logger.py

@@ -220,6 +220,7 @@ def __init__(
         log_record_order: Optional[List[str]] = None,
         utc: bool = False,
         use_rfc3339: bool = False,
+        serialize_stacktrace: bool = None,
         **kwargs,
     ) -> None:
         self.service = resolve_env_var_choice(
@@ -253,6 +254,7 @@ def __init__(
             "log_record_order": log_record_order,
             "utc": utc,
             "use_rfc3339": use_rfc3339,
+            "serialize_stacktrace": serialize_stacktrace
         }
 
         self._init_logger(formatter_options=formatter_options, log_level=level, **kwargs)

aws_lambda_powertools/shared/constants.py

@@ -43,4 +43,4 @@
 POWERTOOLS_DEV_ENV: str = "POWERTOOLS_DEV"
 POWERTOOLS_DEBUG_ENV: str = "POWERTOOLS_DEBUG"
 
-POWERTOOLS_STACKTRACE_ENV: str = "POWERTOOLS_LOGGER_ENHANCED_STACKTRACE"
+POWERTOOLS_STACKTRACE_ENV: str = "POWERTOOLS_LOGGER_SERIALIZE_STACKTRACE"

docs/core/logger.md

@@ -321,7 +321,7 @@ Logger can optionally log uncaught exceptions by setting `log_uncaught_exception
 
 #### Stack trace logging
 
-Logger can optionally log the full stack trace as JSON by setting `logger_formatter=LambdaPowertoolsFormatter(include_stacktrace=True)` at initialization. Optionally, setting the `POWERTOOLS_LOGGER_ENHANCED_STACKTRACE` environment variable to `true` will include stacktrace information in the logs.
+Logger can optionally log the full stack trace as JSON by setting `logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True)` at initialization. Optionally, setting the `POWERTOOLS_LOGGER_SERIALIZE_STACKTRACE` environment variable to `true` will include stacktrace information in the logs.
 
 === "logging_stacktrace.py"
 
@@ -368,7 +368,7 @@ The following environment variables are available to configure Logger at a globa
 | **Event Logging**         | Whether to log the incoming event.                                           | `POWERTOOLS_LOGGER_LOG_EVENT`           | `false` |
 | **Debug Sample Rate**     | Sets the debug log sampling.                                                 | `POWERTOOLS_LOGGER_SAMPLE_RATE`         | `0`     |
 | **Disable Deduplication** | Disables log deduplication filter protection to use Pytest Live Log feature. | `POWERTOOLS_LOG_DEDUPLICATION_DISABLED` | `false` |
-| **Include Stack Trace**   | Includes JSON formatted stack trace in the log output.                       | `POWERTOOLS_LOGGER_ENHANCED_STACKTRACE` | `false` |
+| **Include Stack Trace**   | Includes JSON formatted stack trace in the log output.                       | `POWERTOOLS_LOGGER_SERIALIZE_STACKTRACE` | `false` |
 
 [`POWERTOOLS_LOGGER_LOG_EVENT`](#logging-incoming-event) can also be set on a per-method basis, and [`POWERTOOLS_LOGGER_SAMPLE_RATE`](#sampling-debug-logs) on a per-instance basis. These parameter values will override the environment variable value.
 

docs/index.md

@@ -723,7 +723,7 @@ Core utilities such as Tracing, Logging, Metrics, and Event Handler will be avai
 | **POWERTOOLS_PARAMETERS_SSM_DECRYPT**     | Sets whether to decrypt or not values retrieved from AWS SSM Parameters Store          | [Parameters](./utilities/parameters.md#ssmprovider){target="_blank"}                     | `false`               |
 | **POWERTOOLS_DEV**                        | Increases verbosity across utilities                                                   | Multiple; see [POWERTOOLS_DEV effect below](#optimizing-for-non-production-environments) | `false`               |
 | **LOG_LEVEL**                             | Sets logging level                                                                     | [Logging](./core/logger.md){target="_blank"}                                             | `INFO`                |
-| **POWERTOOLS_LOGGER_ENHANCED_STACKTRACE** | Include JSON formatted stack trace in log message                                      | [Logging](./core/logger.md){target="_blank"}                                             | `false`               |
+| **POWERTOOLS_LOGGER_SERIALIZE_STACKTRACE** | Include JSON formatted stack trace in log message                                      | [Logging](./core/logger.md){target="_blank"}                                             | `false`               |
 
 ### Optimizing for non-production environments
 

examples/logger/src/logging_stacktrace.py

@@ -5,7 +5,7 @@
 from aws_lambda_powertools.logging.formatter import LambdaPowertoolsFormatter
 
 ENDPOINT = "http://httpbin.org/status/500"
-logger = Logger(logger_formatter=LambdaPowertoolsFormatter(include_stacktrace=True))
+logger = Logger(logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True))
 
 
 def lambda_handler(event: dict, context: LambdaContext) -> str:

tests/functional/test_logger.py

@@ -964,18 +964,18 @@ def test_logger_logs_no_stack_trace_without_parameter(stdout):
     logger = Logger(stream=stdout)
 
     try:
-        val = 1 + "someString"
+        raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
     log = capture_logging_output(stdout)
     assert "stack_trace" not in log
 
 def test_logger_logs_stack_trace_with_parameter(stdout):
-    logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(include_stacktrace=True))
+    logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True))
 
     try:
-        val = 1 + "someString"
+        raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
@@ -987,20 +987,19 @@ def test_logger_logs_stack_trace_with_env_var(stdout, monkeypatch: pytest.Monkey
     logger = Logger(stream=stdout)
 
     try:
-        val = 1 + "someString"
+        raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
     log = capture_logging_output(stdout)
     assert "stack_trace" in log
 
-
 def test_logger_logs_no_stack_trace_with_env_var(stdout, monkeypatch: pytest.MonkeyPatch):
     monkeypatch.setenv(constants.POWERTOOLS_STACKTRACE_ENV, "false")
     logger = Logger(stream=stdout)
 
     try:
-        val = 1 + "someString"
+        raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
@@ -1009,12 +1008,23 @@ def test_logger_logs_no_stack_trace_with_env_var(stdout, monkeypatch: pytest.Mon
 
 def test_logger_logs_no_stack_trace_with_parameter_override(stdout, monkeypatch: pytest.MonkeyPatch):
     monkeypatch.setenv(constants.POWERTOOLS_STACKTRACE_ENV, "true")
-    logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(include_stacktrace=False))
+    logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=False))
 
     try:
-        val = 1 + "someString"
+        raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
     log = capture_logging_output(stdout)
     assert "stack_trace" not in log
+
+def test_logger_logs_stack_trace_with_logger_parameter(stdout):
+    logger = Logger(stream=stdout, serialize_stacktrace=True)
+
+    try:
+        raise ValueError("Something went wrong")
+    except Exception as e:
+        logger.exception(e)
+
+    log = capture_logging_output(stdout)
+    assert "stack_trace" in log.keys()