Skip to content

fix(logger): improve behavior with exc_info=True to prevent errors #6417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions aws_lambda_powertools/logging/formatter.py
Original file line number Diff line number Diff line change
Expand Up @@ -357,19 +357,25 @@ def _extract_log_message(self, log_record: logging.LogRecord) -> dict[str, Any]
return message

def _serialize_stacktrace(self, log_record: logging.LogRecord) -> LogStackTrace | None:
if log_record.exc_info:
# Check if the first element of exc_info has the __name__ attribute,
# which indicates it is likely an exception class or object.
# See: https://github.com/aws-powertools/powertools-lambda-python/issues/6358
if isinstance(log_record.exc_info, tuple) and hasattr(log_record.exc_info[0], "__name__"):
exception_info: LogStackTrace = {
"type": log_record.exc_info[0].__name__, # type: ignore
"value": log_record.exc_info[1], # type: ignore
"module": log_record.exc_info[1].__class__.__module__,
"frames": [],
"frames": [
{
"file": fs.filename,
"line": fs.lineno,
"function": fs.name,
"statement": fs.line,
}
for fs in traceback.extract_tb(log_record.exc_info[2])
],
}

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

return None
Expand All @@ -387,7 +393,7 @@ def _extract_log_exception(self, log_record: logging.LogRecord) -> tuple[str, st
log_record: tuple[str, str] | tuple[None, None]
Log record with constant traceback info and exception name
"""
if log_record.exc_info:
if isinstance(log_record.exc_info, tuple) and hasattr(log_record.exc_info[0], "__name__"):
return self.formatException(log_record.exc_info), log_record.exc_info[0].__name__ # type: ignore

return None, None
Expand Down
6 changes: 4 additions & 2 deletions aws_lambda_powertools/utilities/parser/models/appsync.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
from typing import Optional, List, Dict, Union, Any
from typing import Any, Dict, List, Optional, Union

from pydantic import BaseModel


class AppSyncIamIdentity(BaseModel):
accountId: str
cognitoIdentityPoolId: Optional[str]
Expand Down Expand Up @@ -67,4 +69,4 @@ class AppSyncResolverEventModel(BaseModel):
stash: Dict[str, Any]


AppSyncBatchResolverEventModel = List[AppSyncResolverEventModel]
AppSyncBatchResolverEventModel = List[AppSyncResolverEventModel]
13 changes: 13 additions & 0 deletions tests/functional/logger/required_dependencies/test_logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,19 @@ def test_logger_exception_extract_exception_name(stdout, service_name):
assert "ValueError" == log["exception_name"]


def test_logger_exception_should_not_fail_with_exception_block(stdout, service_name):
# GIVEN Logger is initialized
logger = Logger(service=service_name, stream=stdout)

# WHEN calling a logger.exception with a ValueError and outside of a try/except block
logger.exception("Received an exception")

# THEN the log output should not contain "exception_name" or "exception" and not fail
log = capture_logging_output(stdout)
assert "exception_name" not in log
assert "exception" not in log


def test_logger_set_correlation_id(lambda_context, stdout, service_name):
# GIVEN
logger = Logger(service=service_name, stream=stdout)
Expand Down
5 changes: 3 additions & 2 deletions tests/unit/parser/_pydantic/test_appsync.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import pytest

from aws_lambda_powertools.utilities.parser import parse, ValidationError
from aws_lambda_powertools.utilities.parser import ValidationError, parse
from aws_lambda_powertools.utilities.parser.models import AppSyncResolverEventModel
from tests.functional.utils import load_event


def test_appsync_event_model_parses_successfully():
"""
Validate that a valid AppSync resolver event is correctly parsed by the model.
Expand All @@ -24,4 +25,4 @@ def test_appsync_event_model_invalid_payload_raises():
"""
invalid_event = {"invalid": "event"}
with pytest.raises(ValidationError):
parse(event=invalid_event, model=AppSyncResolverEventModel)
parse(event=invalid_event, model=AppSyncResolverEventModel)
Loading