Handle loguru msg levels that are not supported by Sentry (#4147)

Loguru has two message levels `TRACE` and `SUCCESS` that are not
available in Sentry breadcrumbs. This PR maps `TRACE` to `debug` and
`SUCCESS` to `info` in Sentry so those breadcrumbs do not show a
confusing error message in the Sentry UI.

Fixes #2759

Author: antonpirker

sentry_sdk/integrations/loguru.py

@@ -11,7 +11,7 @@
 
 if TYPE_CHECKING:
     from logging import LogRecord
-    from typing import Optional, Tuple
+    from typing import Optional, Tuple, Any
 
 try:
     import loguru
@@ -31,6 +31,16 @@ class LoggingLevels(enum.IntEnum):
     CRITICAL = 50
 
 
+SENTRY_LEVEL_FROM_LOGURU_LEVEL = {
+    "TRACE": "DEBUG",
+    "DEBUG": "DEBUG",
+    "INFO": "INFO",
+    "SUCCESS": "INFO",
+    "WARNING": "WARNING",
+    "ERROR": "ERROR",
+    "CRITICAL": "CRITICAL",
+}
+
 DEFAULT_LEVEL = LoggingLevels.INFO.value
 DEFAULT_EVENT_LEVEL = LoggingLevels.ERROR.value
 # We need to save the handlers to be able to remove them later
@@ -87,14 +97,34 @@ class _LoguruBaseHandler(_BaseHandler):
     def _logging_to_event_level(self, record):
         # type: (LogRecord) -> str
         try:
-            return LoggingLevels(record.levelno).name.lower()
-        except ValueError:
+            return SENTRY_LEVEL_FROM_LOGURU_LEVEL[
+                LoggingLevels(record.levelno).name
+            ].lower()
+        except (ValueError, KeyError):
             return record.levelname.lower() if record.levelname else ""
 
 
 class LoguruEventHandler(_LoguruBaseHandler, EventHandler):
     """Modified version of :class:`sentry_sdk.integrations.logging.EventHandler` to use loguru's level names."""
 
+    def __init__(self, *args, **kwargs):
+        # type: (*Any, **Any) -> None
+        if kwargs.get("level"):
+            kwargs["level"] = SENTRY_LEVEL_FROM_LOGURU_LEVEL.get(
+                kwargs.get("level", ""), DEFAULT_LEVEL
+            )
+
+        super().__init__(*args, **kwargs)
+
 
 class LoguruBreadcrumbHandler(_LoguruBaseHandler, BreadcrumbHandler):
     """Modified version of :class:`sentry_sdk.integrations.logging.BreadcrumbHandler` to use loguru's level names."""
+
+    def __init__(self, *args, **kwargs):
+        # type: (*Any, **Any) -> None
+        if kwargs.get("level"):
+            kwargs["level"] = SENTRY_LEVEL_FROM_LOGURU_LEVEL.get(
+                kwargs.get("level", ""), DEFAULT_LEVEL
+            )
+
+        super().__init__(*args, **kwargs)

tests/integrations/loguru/test_loguru.py

@@ -8,18 +8,18 @@
 
 
 @pytest.mark.parametrize(
-    "level,created_event",
+    "level,created_event,expected_sentry_level",
     [
         # None - no breadcrumb
         # False - no event
         # True - event created
-        (LoggingLevels.TRACE, None),
-        (LoggingLevels.DEBUG, None),
-        (LoggingLevels.INFO, False),
-        (LoggingLevels.SUCCESS, False),
-        (LoggingLevels.WARNING, False),
-        (LoggingLevels.ERROR, True),
-        (LoggingLevels.CRITICAL, True),
+        (LoggingLevels.TRACE, None, "debug"),
+        (LoggingLevels.DEBUG, None, "debug"),
+        (LoggingLevels.INFO, False, "info"),
+        (LoggingLevels.SUCCESS, False, "info"),
+        (LoggingLevels.WARNING, False, "warning"),
+        (LoggingLevels.ERROR, True, "error"),
+        (LoggingLevels.CRITICAL, True, "critical"),
     ],
 )
 @pytest.mark.parametrize("disable_breadcrumbs", [True, False])
@@ -29,6 +29,7 @@ def test_just_log(
     capture_events,
     level,
     created_event,
+    expected_sentry_level,
     disable_breadcrumbs,
     disable_events,
 ):
@@ -48,7 +49,7 @@ def test_just_log(
     formatted_message = (
         " | "
         + "{:9}".format(level.name.upper())
-        + "| tests.integrations.loguru.test_loguru:test_just_log:46 - test"
+        + "| tests.integrations.loguru.test_loguru:test_just_log:47 - test"
     )
 
     if not created_event:
@@ -59,7 +60,7 @@ def test_just_log(
             not disable_breadcrumbs and created_event is not None
         ):  # not None == not TRACE or DEBUG level
             (breadcrumb,) = breadcrumbs
-            assert breadcrumb["level"] == level.name.lower()
+            assert breadcrumb["level"] == expected_sentry_level
             assert breadcrumb["category"] == "tests.integrations.loguru.test_loguru"
             assert breadcrumb["message"][23:] == formatted_message
         else:
@@ -72,7 +73,7 @@ def test_just_log(
         return
 
     (event,) = events
-    assert event["level"] == (level.name.lower())
+    assert event["level"] == expected_sentry_level
     assert event["logger"] == "tests.integrations.loguru.test_loguru"
     assert event["logentry"]["message"][23:] == formatted_message