diff --git a/aws_lambda_powertools/utilities/parser/envelopes/cloudwatch.py b/aws_lambda_powertools/utilities/parser/envelopes/cloudwatch.py index a6dac2c5859..be323a9f7cc 100644 --- a/aws_lambda_powertools/utilities/parser/envelopes/cloudwatch.py +++ b/aws_lambda_powertools/utilities/parser/envelopes/cloudwatch.py @@ -37,8 +37,11 @@ def parse(self, data: dict[str, Any] | Any | None, model: type[T]) -> list[T | N list[T | None] List of records parsed with model provided """ - logger.debug(f"Parsing incoming data with SNS model {CloudWatchLogsModel}") + logger.debug(f"Parsing incoming data with CloudWatchLogs model {CloudWatchLogsModel}") parsed_envelope = CloudWatchLogsModel.model_validate(data) + if parsed_envelope.awslogs.decoded_data.messageType == "CONTROL_MESSAGE": + logger.debug("Skipping parsing for CONTROL_MESSAGE") + return [] logger.debug(f"Parsing CloudWatch records in `body` with {model}") return [ self._parse(data=record.message, model=model) for record in parsed_envelope.awslogs.decoded_data.logEvents diff --git a/aws_lambda_powertools/utilities/parser/models/cloudwatch.py b/aws_lambda_powertools/utilities/parser/models/cloudwatch.py index 8820460257c..25f45043c64 100644 --- a/aws_lambda_powertools/utilities/parser/models/cloudwatch.py +++ b/aws_lambda_powertools/utilities/parser/models/cloudwatch.py @@ -4,12 +4,14 @@ import zlib from datetime import datetime -from pydantic import BaseModel, Field, field_validator +from pydantic import BaseModel, ConfigDict, Field, field_validator logger = logging.getLogger(__name__) class CloudWatchLogsLogEvent(BaseModel): + model_config = ConfigDict(populate_by_name=True) + id: str = Field( description="Unique identifier for the log event within the batch.", examples=["eventId1", "abc123def456"], @@ -22,6 +24,12 @@ class CloudWatchLogsLogEvent(BaseModel): description="The actual log message string or structured JSON payload emitted by the service or application.", examples=["This is a sample log message", '{"statusCode":200,"path":"/hello"}'], ) + extracted_fields: dict[str, str] = Field( + default_factory=dict, + alias="extractedFields", + description="Key-value pairs of fields extracted from the log message if a filter pattern was used.", + examples=[{"timestamp": "2023-01-15T10:30:00Z", "request_id": "1234"}], + ) class CloudWatchLogsDecode(BaseModel): diff --git a/tests/unit/parser/_pydantic/test_cloudwatch.py b/tests/unit/parser/_pydantic/test_cloudwatch.py index 0a1a253d23a..7bc504009f3 100644 --- a/tests/unit/parser/_pydantic/test_cloudwatch.py +++ b/tests/unit/parser/_pydantic/test_cloudwatch.py @@ -186,3 +186,57 @@ def test_cloudwatch_envelope_plain_text_still_fails_for_object_model(): model=MyCloudWatchBusiness, envelope=envelopes.CloudWatchLogsEnvelope, ) + + +def _make_cloudwatch_control_event() -> dict: + inner_event_dict = { + "messageType": "CONTROL_MESSAGE", + "owner": "CloudwatchLogs", + "logGroup": "", + "logStream": "", + "subscriptionFilters": [], + "logEvents": [ + { + "id": "", + "timestamp": 1767323045678, + "message": "CWL CONTROL MESSAGE: Checking health of destination Lambda.", + }, + ], + } + compressed = zlib.compress(json.dumps(inner_event_dict).encode("utf-8"), -1) + return {"awslogs": {"data": base64.b64encode(compressed)}} + + +def test_handle_cloudwatch_control_message_no_envelope(): + raw_event = _make_cloudwatch_control_event() + parsed_event: CloudWatchLogsModel = CloudWatchLogsModel(**raw_event) + + assert parsed_event.awslogs.decoded_data.messageType == "CONTROL_MESSAGE" + assert parsed_event.awslogs.decoded_data.owner == "CloudwatchLogs" + assert parsed_event.awslogs.decoded_data.logGroup == "" + assert parsed_event.awslogs.decoded_data.logStream == "" + assert parsed_event.awslogs.decoded_data.subscriptionFilters == [] + assert len(parsed_event.awslogs.decoded_data.logEvents) == 1 + assert parsed_event.awslogs.decoded_data.policyLevel is None + + +def test_handle_cloudwatch_control_message_with_envelope(): + raw_event = _make_cloudwatch_control_event() + parsed = parse( + event=raw_event, + model=MyCloudWatchBusiness, + envelope=envelopes.CloudWatchLogsEnvelope, + ) + + assert parsed == [] + + +def test_cloudwatch_log_event_extracted_fields(): + log_event = CloudWatchLogsLogEvent( + id="eventId1", + timestamp=1440442987000, + message="sample message", + extractedFields={"request_id": "abc-123", "status": "200"}, + ) + + assert log_event.extracted_fields == {"request_id": "abc-123", "status": "200"}