From 4658128d96baed34f6a1d03acb9f71360a742a87 Mon Sep 17 00:00:00 2001 From: Carey Metcalfe Date: Thu, 24 Oct 2024 23:35:23 -0400 Subject: [PATCH] Always use `LogRecord.getMessage` to get the log body Mostly a revert of #3343 --- .../sdk/_logs/_internal/__init__.py | 17 +---------------- opentelemetry-sdk/tests/logs/test_export.py | 4 ++-- 2 files changed, 3 insertions(+), 18 deletions(-) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py index c2db81687a..86c44a12cc 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py @@ -510,22 +510,7 @@ def _translate(self, record: logging.LogRecord) -> LogRecord: if self.formatter: body = self.format(record) else: - # `record.getMessage()` uses `record.msg` as a template to format - # `record.args` into. There is a special case in `record.getMessage()` - # where it will only attempt formatting if args are provided, - # otherwise, it just stringifies `record.msg`. - # - # Since the OTLP body field has a type of 'any' and the logging module - # is sometimes used in such a way that objects incorrectly end up - # set as record.msg, in those cases we would like to bypass - # `record.getMessage()` completely and set the body to the object - # itself instead of its string representation. - # For more background, see: https://github.com/open-telemetry/opentelemetry-python/pull/4216 - if not record.args and not isinstance(record.msg, str): - # no args are provided so it's *mostly* safe to use the message template as the body - body = record.msg - else: - body = record.getMessage() + body = record.getMessage() # related to https://github.com/open-telemetry/opentelemetry-python/issues/3548 # Severity Text = WARN as defined in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#displaying-severity. diff --git a/opentelemetry-sdk/tests/logs/test_export.py b/opentelemetry-sdk/tests/logs/test_export.py index 2e00bad653..be70f0514f 100644 --- a/opentelemetry-sdk/tests/logs/test_export.py +++ b/opentelemetry-sdk/tests/logs/test_export.py @@ -217,8 +217,8 @@ def test_simple_log_record_processor_different_msg_types(self): "Temperature hits high 420 C in Hyderabad", "CRITICAL", ), - (["list", "of", "strings"], "WARN"), - ({"key": "value"}, "ERROR"), + ("['list', 'of', 'strings']", "WARN"), + ("{'key': 'value'}", "ERROR"), ] emitted = [ (item.log_record.body, item.log_record.severity_text)