feat(ourlogs): Make the python logger go to ourlogs

Author: colin-sentry

sentry_sdk/_experimental_logger.py

@@ -9,7 +9,10 @@ def _capture_log(severity_text, severity_number, template, **kwargs):
     # type: (str, int, str, **Any) -> None
     client = get_client()
     scope = get_current_scope()
-    client.capture_log(scope, severity_text, severity_number, template, **kwargs)
+    kwargs["sentry.message.template"] = template
+    client.capture_log(
+        scope, severity_text, severity_number, template.format(**kwargs), **kwargs
+    )
 
 
 trace = functools.partial(_capture_log, "trace", 1)

sentry_sdk/client.py

@@ -209,7 +209,9 @@ def capture_event(self, *args, **kwargs):
         # type: (*Any, **Any) -> Optional[str]
         return None
 
-    def capture_log(self, scope, severity_text, severity_number, template, **kwargs):
+    def _capture_experimental_log(
+        self, scope, severity_text, severity_number, body, **kwargs
+    ):
         # type: (Scope, str, int, str, **Any) -> None
         pass
 
@@ -854,7 +856,9 @@ def capture_event(
 
         return return_value
 
-    def capture_log(self, scope, severity_text, severity_number, template, **kwargs):
+    def _capture_experimental_log(
+        self, scope, severity_text, severity_number, body, **kwargs
+    ):
         # type: (Scope, str, int, str, **Any) -> None
         logs_enabled = self.options["_experiments"].get("enable_sentry_logs", False)
         if not logs_enabled:
@@ -864,9 +868,7 @@ def capture_log(self, scope, severity_text, severity_number, template, **kwargs)
             "sent_at": format_timestamp(datetime.now(timezone.utc)),
         }  # type: dict[str, object]
 
-        attrs = {
-            "sentry.message.template": template,
-        }  # type: dict[str, str | bool | float | int]
+        attrs = {}  # type: dict[str, str | bool | float | int]
 
         kwargs_attributes = kwargs.get("attributes")
         if kwargs_attributes is not None:
@@ -890,9 +892,9 @@ def capture_log(self, scope, severity_text, severity_number, template, **kwargs)
         log = {
             "severity_text": severity_text,
             "severity_number": severity_number,
-            "body": template.format(**kwargs),
+            "body": body,
             "attributes": attrs,
-            "time_unix_nano": time.time_ns(),
+            "time_unix_nano": kwargs.pop("time_unix_nano", time.time_ns()),
             "trace_id": None,
         }  # type: Log
 
@@ -907,6 +909,7 @@ def capture_log(self, scope, severity_text, severity_number, template, **kwargs)
                 "error": logging.ERROR,
                 "fatal": logging.CRITICAL,
             }
+            # Be careful editing this line, you can add infinite logging loops with the logger integration
             logger.log(
                 severity_text_to_logging_level.get(severity_text, logging.DEBUG),
                 f'[Sentry Logs] {log["body"]}',

sentry_sdk/consts.py

@@ -78,6 +78,7 @@ class CompressionAlgo(Enum):
                 Callable[[str, MetricValue, MeasurementUnit, MetricTags], bool]
             ],
             "metric_code_locations": Optional[bool],
+            "enable_sentry_logs": Optional[bool],
         },
         total=False,
     )

sentry_sdk/integrations/logging.py

@@ -1,8 +1,10 @@
+import json
 import logging
 from datetime import datetime, timezone
 from fnmatch import fnmatch
 
 import sentry_sdk
+from sentry_sdk.client import BaseClient
 from sentry_sdk.utils import (
     to_string,
     event_from_exception,
@@ -65,9 +67,11 @@ def __init__(self, level=DEFAULT_LEVEL, event_level=DEFAULT_EVENT_LEVEL):
         # type: (Optional[int], Optional[int]) -> None
         self._handler = None
         self._breadcrumb_handler = None
+        self._sentry_logs_handler = None
 
         if level is not None:
             self._breadcrumb_handler = BreadcrumbHandler(level=level)
+            self._sentry_logs_handler = SentryLogsHandler(level=level)
 
         if event_level is not None:
             self._handler = EventHandler(level=event_level)
@@ -83,6 +87,12 @@ def _handle_record(self, record):
         ):
             self._breadcrumb_handler.handle(record)
 
+        if (
+            self._sentry_logs_handler is not None
+            and record.levelno >= self._sentry_logs_handler.level
+        ):
+            self._sentry_logs_handler.handle(record)
+
     @staticmethod
     def setup_once():
         # type: () -> None
@@ -296,3 +306,91 @@ def _breadcrumb_from_record(self, record):
             "timestamp": datetime.fromtimestamp(record.created, timezone.utc),
             "data": self._extra_from_record(record),
         }
+
+
+def _python_level_to_otel(record_level):
+    # type: (int) -> (int, str)
+    for py_level, otel_severity_number, otel_severity_text in [
+        (50, 21, "fatal"),
+        (40, 17, "error"),
+        (30, 13, "warn"),
+        (20, 9, "info"),
+        (10, 5, "debug"),
+        (5, 1, "trace"),
+        (0, 0, "default"),
+    ]:
+        if max(record_level, 0) >= py_level:
+            return otel_severity_number, otel_severity_text
+
+
+class SentryLogsHandler(_BaseHandler):
+    """
+    A logging handler that records Sentry logs for each Python log record.
+
+    Note that you do not have to use this class if the logging integration is enabled, which it is by default.
+    """
+
+    def emit(self, record):
+        # type: (LogRecord) -> Any
+        with capture_internal_exceptions():
+            self.format(record)
+            if not self._can_record(record):
+                return
+
+            client = sentry_sdk.get_client()
+            if not client.is_active():
+                return
+
+            if not client.options["_experiments"].get("enable_sentry_logs", False):
+                return
+
+            if record.msg.startswith("[Sentry Logs]"):
+                return  # avoid infinite loop when debug is true
+
+            SentryLogsHandler._capture_log_from_record(client, record)
+
+    @staticmethod
+    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)
+        kwargs = {
+            "sentry.message.template": (
+                record.msg if isinstance(record.msg, str) else json.dumps(record.msg)
+            ),
+        }
+        if record.args is not None:
+            if isinstance(record.args, tuple):
+                for i, arg in enumerate(record.args):
+                    kwargs[f"sentry.message.parameters.{i}"] = (
+                        arg if isinstance(arg, str) else json.dumps(arg)
+                    )
+        if record.lineno:
+            kwargs["code.line.number"] = record.lineno
+        if record.pathname:
+            kwargs["code.file.path"] = record.pathname
+        if record.funcName:
+            kwargs["code.function.name"] = record.funcName
+
+        if record.thread:
+            kwargs["thread.id"] = record.thread
+        if record.threadName:
+            kwargs["thread.name"] = record.threadName
+
+        if record.process:
+            kwargs["process.pid"] = record.process
+        if record.processName:
+            kwargs["process.executable.name"] = record.processName
+        if record.name:
+            kwargs["logger.name"] = record.name
+        if record.created:
+            kwargs["time_unix_nano"] = int(record.created * 1e9)
+
+        # noinspection PyProtectedMember
+        client._capture_experimental_log(
+            scope,
+            otel_severity_text,
+            otel_severity_number,
+            record.getMessage(),
+            **kwargs,
+        )