Removed env variable and default stack trace logging to True

Author: stevrobu

aws_lambda_powertools/logging/formatter.py

@@ -82,7 +82,7 @@ def __init__(
         log_record_order: List[str] | None = None,
         utc: bool = False,
         use_rfc3339: bool = False,
-        serialize_stacktrace: bool = None,
+        serialize_stacktrace: bool = True,
         **kwargs,
     ) -> None:
         """Return a LambdaPowertoolsFormatter instance.
@@ -154,9 +154,7 @@ def __init__(
         self.keys_combined = {**self._build_default_keys(), **kwargs}
         self.log_format.update(**self.keys_combined)
 
-        self.serialize_stacktrace = resolve_truthy_env_var_choice(env=os.getenv(constants.POWERTOOLS_STACKTRACE_ENV, "false"),
-                                                               choice=serialize_stacktrace,
-                                                               )
+        self.serialize_stacktrace = serialize_stacktrace
 
         super().__init__(datefmt=self.datefmt)
 

aws_lambda_powertools/logging/logger.py

@@ -220,7 +220,7 @@ def __init__(
         log_record_order: Optional[List[str]] = None,
         utc: bool = False,
         use_rfc3339: bool = False,
-        serialize_stacktrace: bool = None,
+        serialize_stacktrace: bool = True,
         **kwargs,
     ) -> None:
         self.service = resolve_env_var_choice(

aws_lambda_powertools/shared/constants.py

@@ -42,5 +42,3 @@
 
 POWERTOOLS_DEV_ENV: str = "POWERTOOLS_DEV"
 POWERTOOLS_DEBUG_ENV: str = "POWERTOOLS_DEBUG"
-
-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(serialize_stacktrace=True)` at initialization. Optionally, setting the `POWERTOOLS_LOGGER_SERIALIZE_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.
 
 === "logging_stacktrace.py"
 
@@ -368,7 +368,6 @@ 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_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,6 @@ 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_SERIALIZE_STACKTRACE** | Include JSON formatted stack trace in log message                                      | [Logging](./core/logger.md){target="_blank"}                                             | `false`               |
 
 ### Optimizing for non-production environments
 

tests/functional/test_logger.py

@@ -960,7 +960,7 @@ def test_stream_defaults_to_stdout(service_name, capsys):
     log = json.loads(capsys.readouterr().out.strip())
     assert log["message"] == msg
 
-def test_logger_logs_no_stack_trace_without_parameter(stdout):
+def test_logger_logs_stack_trace_without_parameter(stdout):
     logger = Logger(stream=stdout)
 
     try:
@@ -969,7 +969,7 @@ def test_logger_logs_no_stack_trace_without_parameter(stdout):
         logger.exception(e)
 
     log = capture_logging_output(stdout)
-    assert "stack_trace" not in log
+    assert "stack_trace" in log
 
 def test_logger_logs_stack_trace_with_parameter(stdout):
     logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=True))
@@ -982,21 +982,8 @@ def test_logger_logs_stack_trace_with_parameter(stdout):
     log = capture_logging_output(stdout)
     assert "stack_trace" in log
 
-def test_logger_logs_stack_trace_with_env_var(stdout, monkeypatch: pytest.MonkeyPatch):
-    monkeypatch.setenv(constants.POWERTOOLS_STACKTRACE_ENV, "true")
-    logger = Logger(stream=stdout)
-
-    try:
-        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)
+def test_logger_logs_no_stack_trace_with_parameter_false(stdout):
+    logger = Logger(stream=stdout, logger_formatter=LambdaPowertoolsFormatter(serialize_stacktrace=False))
 
     try:
         raise ValueError("Something went wrong")
@@ -1006,25 +993,24 @@ def test_logger_logs_no_stack_trace_with_env_var(stdout, monkeypatch: pytest.Mon
     log = capture_logging_output(stdout)
     assert "stack_trace" not in log
 
-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(serialize_stacktrace=False))
+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" not in log
+    assert "stack_trace" in log.keys()
 
-def test_logger_logs_stack_trace_with_logger_parameter(stdout):
-    logger = Logger(stream=stdout, serialize_stacktrace=True)
+def test_logger_logs_no_stack_trace_with_logger_parameter_false(stdout):
+    logger = Logger(stream=stdout, serialize_stacktrace=False)
 
     try:
         raise ValueError("Something went wrong")
     except Exception as e:
         logger.exception(e)
 
     log = capture_logging_output(stdout)
-    assert "stack_trace" in log.keys()
+    assert "stack_trace" not in log.keys()