feat(logging): Add formatted message to log events

sentry_sdk/integrations/logging.py

@@ -259,11 +259,13 @@ def _emit(self, record):
 
             event["logentry"] = {
                 "message": msg,
+                "formatted": record.getMessage(),
                 "params": (),
             }
 
         else:
             event["logentry"] = {
+                "formatted": record.getMessage(),
                 "message": to_string(record.msg),
                 "params": record.args,
             }

tests/integrations/logging/test_logging.py

@@ -26,6 +26,7 @@ def test_logging_works_with_many_loggers(sentry_init, capture_events, logger):
     assert event["level"] == "fatal"
     assert not event["logentry"]["params"]
     assert event["logentry"]["message"] == "LOL"
+    assert event["logentry"]["formatted"] == "LOL"
     assert any(crumb["message"] == "bread" for crumb in event["breadcrumbs"]["values"])
 
 
@@ -112,6 +113,7 @@ def test_logging_level(sentry_init, capture_events):
     (event,) = events
     assert event["level"] == "error"
     assert event["logentry"]["message"] == "hi"
+    assert event["logentry"]["formatted"] == "hi"
 
     del events[:]
 
@@ -152,6 +154,7 @@ def test_custom_log_level_names(sentry_init, capture_events):
         assert events
         assert events[0]["level"] == sentry_level
         assert events[0]["logentry"]["message"] == "Trying level %s"
+        assert events[0]["logentry"]["formatted"] == f"Trying level {logging_level}"
         assert events[0]["logentry"]["params"] == [logging_level]
 
         del events[:]
@@ -177,6 +180,7 @@ def filter(self, record):
 
     (event,) = events
     assert event["logentry"]["message"] == "hi"
+    assert event["logentry"]["formatted"] == "hi"
 
 
 def test_logging_captured_warnings(sentry_init, capture_events, recwarn):
@@ -198,10 +202,16 @@ def test_logging_captured_warnings(sentry_init, capture_events, recwarn):
     assert events[0]["level"] == "warning"
     # Captured warnings start with the path where the warning was raised
     assert "UserWarning: first" in events[0]["logentry"]["message"]
+    assert "UserWarning: first" in events[0]["logentry"]["formatted"]
+    # For warnings, the message and formatted message are the same
+    assert events[0]["logentry"]["message"] == events[0]["logentry"]["formatted"]
     assert events[0]["logentry"]["params"] == []
 
     assert events[1]["level"] == "warning"
     assert "UserWarning: second" in events[1]["logentry"]["message"]
+    assert "UserWarning: second" in events[1]["logentry"]["formatted"]
+    # For warnings, the message and formatted message are the same
+    assert events[1]["logentry"]["message"] == events[1]["logentry"]["formatted"]
     assert events[1]["logentry"]["params"] == []
 
     # Using recwarn suppresses the "third" warning in the test output
@@ -234,6 +244,7 @@ def test_ignore_logger_wildcard(sentry_init, capture_events):
 
     (event,) = events
     assert event["logentry"]["message"] == "hi"
+    assert event["logentry"]["formatted"] == "hi"
 
 
 def test_logging_dictionary_interpolation(sentry_init, capture_events):
@@ -245,6 +256,10 @@ def test_logging_dictionary_interpolation(sentry_init, capture_events):
 
     (event,) = events
     assert event["logentry"]["message"] == "this is a log with a dictionary %s"
+    assert (
+        event["logentry"]["formatted"]
+        == "this is a log with a dictionary {'foo': 'bar'}"
+    )
     assert event["logentry"]["params"] == {"foo": "bar"}
 
 
@@ -263,4 +278,8 @@ def test_logging_dictionary_args(sentry_init, capture_events):
         event["logentry"]["message"]
         == "the value of foo is %(foo)s, and the value of bar is %(bar)s"
     )
+    assert (
+        event["logentry"]["formatted"]
+        == "the value of foo is bar, and the value of bar is baz"
+    )
     assert event["logentry"]["params"] == {"foo": "bar", "bar": "baz"}