Group captured warnings under separate issues (#1324)

Prior to https://bugs.python.org/issue46557 being addressed, warnings
captured by logging.captureWarnings(True) were logged with
logger.warning("%s", s) which caused them to be grouped under the same
issue. This change adds special handling for creating separate issues
for captured warnings arriving with the %s format string by using
args[0] as the message instead of the msg arg.

Author: mnito

sentry_sdk/integrations/logging.py

@@ -222,7 +222,27 @@ def _emit(self, record):
 
         event["level"] = _logging_to_event_level(record.levelname)
         event["logger"] = record.name
-        event["logentry"] = {"message": to_string(record.msg), "params": record.args}
+
+        # Log records from `warnings` module as separate issues
+        record_caputured_from_warnings_module = (
+            record.name == "py.warnings" and record.msg == "%s"
+        )
+        if record_caputured_from_warnings_module:
+            # use the actual message and not "%s" as the message
+            # this prevents grouping all warnings under one "%s" issue
+            msg = record.args[0]  # type: ignore
+
+            event["logentry"] = {
+                "message": msg,
+                "params": (),
+            }
+
+        else:
+            event["logentry"] = {
+                "message": to_string(record.msg),
+                "params": record.args,
+            }
+
         event["extra"] = _extra_from_record(record)
 
         hub.capture_event(event, hint=hint)

tests/integrations/logging/test_logging.py

@@ -2,6 +2,7 @@
 
 import pytest
 import logging
+import warnings
 
 from sentry_sdk.integrations.logging import LoggingIntegration, ignore_logger
 
@@ -136,6 +137,36 @@ def filter(self, record):
     assert event["logentry"]["message"] == "hi"
 
 
+def test_logging_captured_warnings(sentry_init, capture_events, recwarn):
+    sentry_init(
+        integrations=[LoggingIntegration(event_level="WARNING")],
+        default_integrations=False,
+    )
+    events = capture_events()
+
+    logging.captureWarnings(True)
+    warnings.warn("first")
+    warnings.warn("second")
+    logging.captureWarnings(False)
+
+    warnings.warn("third")
+
+    assert len(events) == 2
+
+    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 events[0]["logentry"]["params"] == []
+
+    assert events[1]["level"] == "warning"
+    assert "UserWarning: second" in events[1]["logentry"]["message"]
+    assert events[1]["logentry"]["params"] == []
+
+    # Using recwarn suppresses the "third" warning in the test output
+    assert len(recwarn) == 1
+    assert str(recwarn[0].message) == "third"
+
+
 def test_ignore_logger(sentry_init, capture_events):
     sentry_init(integrations=[LoggingIntegration()], default_integrations=False)
     events = capture_events()