From 880a816e61556da67eea18d68e3f413f36b79c97 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Tue, 13 May 2025 09:55:53 -0400 Subject: [PATCH] fix(logs): Make `sentry.message.parameters` singular as per spec --- sentry_sdk/integrations/logging.py | 2 +- sentry_sdk/logger.py | 2 +- tests/test_logs.py | 23 +++++++++++------------ 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/sentry_sdk/integrations/logging.py b/sentry_sdk/integrations/logging.py index 74baf3d33a..449a05fbf7 100644 --- a/sentry_sdk/integrations/logging.py +++ b/sentry_sdk/integrations/logging.py @@ -362,7 +362,7 @@ def _capture_log_from_record(self, client, record): if record.args is not None: if isinstance(record.args, tuple): for i, arg in enumerate(record.args): - attrs[f"sentry.message.parameters.{i}"] = ( + attrs[f"sentry.message.parameter.{i}"] = ( arg if isinstance(arg, str) or isinstance(arg, float) diff --git a/sentry_sdk/logger.py b/sentry_sdk/logger.py index 1fa31b786b..704d7d4f9d 100644 --- a/sentry_sdk/logger.py +++ b/sentry_sdk/logger.py @@ -18,7 +18,7 @@ def _capture_log(severity_text, severity_number, template, **kwargs): if "attributes" in kwargs: attrs.update(kwargs.pop("attributes")) for k, v in kwargs.items(): - attrs[f"sentry.message.parameters.{k}"] = v + attrs[f"sentry.message.parameter.{k}"] = v attrs = { k: ( diff --git a/tests/test_logs.py b/tests/test_logs.py index 1f6b07e762..ec8ce917c2 100644 --- a/tests/test_logs.py +++ b/tests/test_logs.py @@ -186,7 +186,7 @@ def test_logs_attributes(sentry_init, capture_envelopes): assert logs[0]["attributes"][k] == v assert logs[0]["attributes"]["sentry.environment"] == "production" assert "sentry.release" in logs[0]["attributes"] - assert logs[0]["attributes"]["sentry.message.parameters.my_var"] == "some value" + assert logs[0]["attributes"]["sentry.message.parameter.my_var"] == "some value" assert logs[0]["attributes"][SPANDATA.SERVER_ADDRESS] == "test-server" assert logs[0]["attributes"]["sentry.sdk.name"].startswith("sentry.python") assert logs[0]["attributes"]["sentry.sdk.version"] == VERSION @@ -214,23 +214,23 @@ def test_logs_message_params(sentry_init, capture_envelopes): logs = envelopes_to_logs(envelopes) assert logs[0]["body"] == "The recorded value was '1'" - assert logs[0]["attributes"]["sentry.message.parameters.int_var"] == 1 + assert logs[0]["attributes"]["sentry.message.parameter.int_var"] == 1 assert logs[1]["body"] == "The recorded value was '2.0'" - assert logs[1]["attributes"]["sentry.message.parameters.float_var"] == 2.0 + assert logs[1]["attributes"]["sentry.message.parameter.float_var"] == 2.0 assert logs[2]["body"] == "The recorded value was 'False'" - assert logs[2]["attributes"]["sentry.message.parameters.bool_var"] is False + assert logs[2]["attributes"]["sentry.message.parameter.bool_var"] is False assert logs[3]["body"] == "The recorded value was 'some string value'" assert ( - logs[3]["attributes"]["sentry.message.parameters.string_var"] + logs[3]["attributes"]["sentry.message.parameter.string_var"] == "some string value" ) assert logs[4]["body"] == "The recorded error was 'some error'" assert ( - logs[4]["attributes"]["sentry.message.parameters.error"] + logs[4]["attributes"]["sentry.message.parameter.error"] == "Exception('some error')" ) @@ -287,8 +287,8 @@ def test_logger_integration_warning(sentry_init, capture_envelopes): assert "code.line.number" in attrs assert attrs["logger.name"] == "test-logger" assert attrs["sentry.environment"] == "production" - assert attrs["sentry.message.parameters.0"] == "1" - assert attrs["sentry.message.parameters.1"] == "2" + assert attrs["sentry.message.parameter.0"] == "1" + assert attrs["sentry.message.parameter.1"] == "2" assert attrs["sentry.origin"] == "auto.logger.log" assert logs[0]["severity_number"] == 13 assert logs[0]["severity_text"] == "warn" @@ -349,14 +349,13 @@ def test_logging_errors(sentry_init, capture_envelopes): logs = envelopes_to_logs(envelopes) assert logs[0]["severity_text"] == "error" assert "sentry.message.template" not in logs[0]["attributes"] - assert "sentry.message.parameters.0" not in logs[0]["attributes"] + assert "sentry.message.parameter.0" not in logs[0]["attributes"] assert "code.line.number" in logs[0]["attributes"] assert logs[1]["severity_text"] == "error" assert logs[1]["attributes"]["sentry.message.template"] == "error is %s" assert ( - logs[1]["attributes"]["sentry.message.parameters.0"] - == "Exception('test exc 2')" + logs[1]["attributes"]["sentry.message.parameter.0"] == "Exception('test exc 2')" ) assert "code.line.number" in logs[1]["attributes"] @@ -456,7 +455,7 @@ def test_logger_with_all_attributes(sentry_init, capture_envelopes): "logger.name": "test-logger", "sentry.origin": "auto.logger.log", "sentry.message.template": "log #%d", - "sentry.message.parameters.0": 1, + "sentry.message.parameter.0": 1, "sentry.environment": "production", "sentry.sdk.name": "sentry.python", "sentry.sdk.version": VERSION,