fix(logger): ensure logs stream to stdout by default, not stderr (aws-powertools#2736)

heitorlessa · web-flow · commit 288ce7e76cf5 · 2023-07-10T21:59:22.000+02:00
diff --git a/aws_lambda_powertools/logging/logger.py b/aws_lambda_powertools/logging/logger.py
@@ -232,7 +232,8 @@ def __init__(
         )
         self.child = child
         self.logger_formatter = logger_formatter
-        self.logger_handler = logger_handler or logging.StreamHandler(stream)
+        self._stream = stream or sys.stdout
+        self.logger_handler = logger_handler or logging.StreamHandler(self._stream)
         self.log_uncaught_exceptions = log_uncaught_exceptions
 
         self._is_deduplication_disabled = resolve_truthy_env_var_choice(
diff --git a/tests/functional/test_logger.py b/tests/functional/test_logger.py
@@ -945,3 +945,17 @@ def test_logger_log_uncaught_exceptions(service_name, stdout):
     # THEN it should contain our custom exception hook with a copy of our logger
     assert isinstance(exception_hook, functools.partial)
     assert exception_hook.keywords.get("logger") == logger
+
+
+def test_stream_defaults_to_stdout(service_name, capsys):
+    # GIVEN Logger is initialized without any explicit stream
+    logger = Logger(service=service_name)
+    msg = "testing stdout"
+
+    # WHEN logging statements are issued
+    logger.info(msg)
+
+    # THEN we should default to standard output, not standard error.
+    # NOTE: we can't assert on capsys.readouterr().err due to a known bug: https://github.com/pytest-dev/pytest/issues/5997
+    log = json.loads(capsys.readouterr().out.strip())
+    assert log["message"] == msg

Original file line number	Diff line number	Diff line change
`@@ -232,7 +232,8 @@ def __init__(`
`232`	`232`	`)`
`233`	`233`	`self.child = child`
`234`	`234`	`self.logger_formatter = logger_formatter`
`235`		`- self.logger_handler = logger_handler or logging.StreamHandler(stream)`
	`235`	`+ self._stream = stream or sys.stdout`
	`236`	`+ self.logger_handler = logger_handler or logging.StreamHandler(self._stream)`
`236`	`237`	`self.log_uncaught_exceptions = log_uncaught_exceptions`
`237`	`238`
`238`	`239`	`self._is_deduplication_disabled = resolve_truthy_env_var_choice(`