diff --git a/sentry_sdk/integrations/logging.py b/sentry_sdk/integrations/logging.py index 2114f4867a..7822608de8 100644 --- a/sentry_sdk/integrations/logging.py +++ b/sentry_sdk/integrations/logging.py @@ -1,4 +1,3 @@ -import json import logging from datetime import datetime, timezone from fnmatch import fnmatch @@ -6,6 +5,7 @@ import sentry_sdk from sentry_sdk.client import BaseClient from sentry_sdk.utils import ( + safe_repr, to_string, event_from_exception, current_stacktrace, @@ -358,16 +358,14 @@ def _capture_log_from_record(client, record): # type: (BaseClient, LogRecord) -> None scope = sentry_sdk.get_current_scope() otel_severity_number, otel_severity_text = _python_level_to_otel(record.levelno) - attrs = { - "sentry.message.template": ( - record.msg if isinstance(record.msg, str) else json.dumps(record.msg) - ), - } # type: dict[str, str | bool | float | int] + attrs = {} # type: dict[str, str | bool | float | int] + if isinstance(record.msg, str): + attrs["sentry.message.template"] = record.msg if record.args is not None: if isinstance(record.args, tuple): for i, arg in enumerate(record.args): attrs[f"sentry.message.parameters.{i}"] = ( - arg if isinstance(arg, str) else json.dumps(arg) + arg if isinstance(arg, str) else safe_repr(arg) ) if record.lineno: attrs["code.line.number"] = record.lineno diff --git a/tests/test_logs.py b/tests/test_logs.py index 9527fb9807..7ef708ceb1 100644 --- a/tests/test_logs.py +++ b/tests/test_logs.py @@ -281,3 +281,41 @@ def test_no_log_infinite_loop(sentry_init, capture_envelopes): python_logger.debug("this is %s a template %s", "1", "2") assert len(envelopes) == 1 + + +@minimum_python_37 +def test_logging_errors(sentry_init, capture_envelopes): + """ + The python logger module should be able to log errors without erroring + """ + sentry_init(_experiments={"enable_sentry_logs": True}) + envelopes = capture_envelopes() + + python_logger = logging.Logger("test-logger") + python_logger.error(Exception("test exc 1")) + python_logger.error("error is %s", Exception("test exc 2")) + + error_event_1 = envelopes[0].items[0].payload.json + assert error_event_1["level"] == "error" + + log_event_1 = envelopes[1].items[0].payload.json + assert log_event_1["severityText"] == "error" + # When only logging an exception, there is no "sentry.message.template" or "sentry.message.parameters.0" + assert len(log_event_1["attributes"]) == 10 + assert log_event_1["attributes"][0]["key"] == "code.line.number" + + error_event_2 = envelopes[2].items[0].payload.json + assert error_event_2["level"] == "error" + + log_event_2 = envelopes[3].items[0].payload.json + assert log_event_2["severityText"] == "error" + assert len(log_event_2["attributes"]) == 12 + assert log_event_2["attributes"][0]["key"] == "sentry.message.template" + assert log_event_2["attributes"][0]["value"] == {"stringValue": "error is %s"} + assert log_event_2["attributes"][1]["key"] == "sentry.message.parameters.0" + assert log_event_2["attributes"][1]["value"] == { + "stringValue": "Exception('test exc 2')" + } + assert log_event_2["attributes"][2]["key"] == "code.line.number" + + assert len(envelopes) == 4