feat(ourlogs): Add alpha version of logger

Author: colin-sentry

sentry_sdk/__init__.py

@@ -45,6 +45,7 @@
     "start_transaction",
     "trace",
     "monitor",
+    "logger",
 ]
 
 # Initialize the debug support after everything is loaded

sentry_sdk/_types.py

@@ -207,6 +207,7 @@ class SDKInfo(TypedDict):
     ]
 
     Hint = Dict[str, Any]
+    Log = Dict[str, Any]
 
     Breadcrumb = Dict[str, Any]
     BreadcrumbHint = Dict[str, Any]
@@ -217,6 +218,7 @@ class SDKInfo(TypedDict):
     ErrorProcessor = Callable[[Event, ExcInfo], Optional[Event]]
     BreadcrumbProcessor = Callable[[Breadcrumb, BreadcrumbHint], Optional[Breadcrumb]]
     TransactionProcessor = Callable[[Event, Hint], Optional[Event]]
+    LogProcessor = Callable[[Log, Hint], Optional[Log]]
 
     TracesSampler = Callable[[SamplingContext], Union[float, int, bool]]
 

sentry_sdk/client.py

@@ -1,4 +1,6 @@
+import json
 import os
+import time
 import uuid
 import random
 import socket
@@ -8,6 +10,7 @@
 from typing import TYPE_CHECKING, List, Dict, cast, overload
 import warnings
 
+from sentry_sdk import get_current_scope
 from sentry_sdk._compat import PY37, check_uwsgi_thread_support
 from sentry_sdk.utils import (
     AnnotatedValue,
@@ -206,6 +209,10 @@ def capture_event(self, *args, **kwargs):
         # type: (*Any, **Any) -> Optional[str]
         return None
 
+    def capture_log(self, severity_text, severity_number, template, **kwargs):
+        # type: (str, int, str, **Any) -> None
+        pass
+
     def capture_session(self, *args, **kwargs):
         # type: (*Any, **Any) -> None
         return None
@@ -847,6 +854,69 @@ def capture_event(
 
         return return_value
 
+    def capture_log(self, severity_text, severity_number, template, **kwargs):
+        # type: (str, int, str, **Any) -> None
+        if not self.options.get("enable_sentry_logs", False):
+            return
+
+        headers = {
+            "sent_at": format_timestamp(datetime.now(timezone.utc)),
+        }  # type: dict[str, object]
+
+        def format_attribute(key: str, val: int | float | str | bool):
+            if isinstance(val, int):
+                return {"key": key, "value": {"int_value": val}}
+            if isinstance(val, str):
+                return {"key": key, "value": {"string_value": val}}
+            if isinstance(val, float):
+                return {"key": key, "value": {"double_value": val}}
+            if isinstance(val, bool):
+                return {"key": key, "value": {"bool_value": val}}
+            return {"key": key, "value": {"string_value": json.dumps(val)}}
+
+        attrs = {
+            "sentry.message.template": template,
+        }
+        if (extra_attrs := kwargs.get("attributes")) is not None:
+            attrs.update(extra_attrs)
+        if (env := self.options.get("environment")) is not None:
+            attrs["sentry.environment"] = env
+        if (release := self.options.get("release")) is not None:
+            attrs["sentry.release"] = release
+        for k, v in kwargs.items():
+            attrs[f"sentry.message.parameters.{k}"] = v
+
+        log = {
+            "severity_text": severity_text,
+            "severity_number": severity_number,
+            "body": template.format(**kwargs),
+            "attributes": attrs,
+            "time_unix_nano": time.time_ns(),
+        }
+
+        if (ctx := get_current_scope().get_active_propagation_context()) is not None:
+            headers["trace_id"] = ctx.trace_id
+            log["trace_id"] = ctx.trace_id
+        envelope = Envelope(headers=headers)
+
+        before_send_log = self.options.get("before_send_log")
+        if before_send_log is not None:
+            log = before_send_log(log)
+
+        # convert to otel form - otel_log has a different schema than just 'log'
+        log["body"] = {"string_value": log["body"]}
+        log["attributes"] = [
+            format_attribute(k, v) for (k, v) in log["attributes"].items()
+        ]
+
+        envelope.add_log(log)  # TODO: batch these
+        if self.spotlight:
+            self.spotlight.capture_envelope(envelope)
+
+        if self.transport is not None:
+            self.transport.capture_envelope(envelope)
+        return None
+
     def capture_session(
         self, session  # type: Session
     ):

sentry_sdk/consts.py

@@ -53,6 +53,7 @@ class CompressionAlgo(Enum):
         TransactionProcessor,
         MetricTags,
         MetricValue,
+        LogProcessor,
     )
 
     # Experiments are feature flags to enable and disable certain unstable SDK
@@ -539,6 +540,8 @@ def __init__(
         proxy_headers=None,  # type: Optional[Dict[str, str]]
         instrumenter=INSTRUMENTER.SENTRY,  # type: Optional[str]
         before_send_transaction=None,  # type: Optional[TransactionProcessor]
+        enable_sentry_logs=False,  # type: bool
+        before_send_log=None,  # type: Optional[LogProcessor]
         project_root=None,  # type: Optional[str]
         enable_tracing=None,  # type: Optional[bool]
         include_local_variables=True,  # type: Optional[bool]

sentry_sdk/envelope.py

@@ -15,7 +15,7 @@
     from typing import List
     from typing import Iterator
 
-    from sentry_sdk._types import Event, EventDataCategory
+    from sentry_sdk._types import Event, EventDataCategory, Log
 
 
 def parse_json(data):
@@ -102,6 +102,12 @@ def add_sessions(
         # type: (...) -> None
         self.add_item(Item(payload=PayloadRef(json=sessions), type="sessions"))
 
+    def add_log(
+        self, log  # type: Log
+    ):
+        # type: (...) -> None
+        self.add_item(Item(payload=PayloadRef(json=log), type="otel_log"))
+
     def add_item(
         self, item  # type: Item
     ):

sentry_sdk/logger.py

@@ -0,0 +1,19 @@
+# NOTE: this is the logger sentry exposes to users, not some generic logger.
+import functools
+from typing import Any, Optional
+
+from sentry_sdk import get_client
+
+
+def capture_log(severity_text, severity_number, template, **kwargs):
+    # type: (str, int, str, **Any) -> Optional[str]
+    client = get_client()
+    return client.capture_log(severity_text, severity_number, template, **kwargs)
+
+
+trace = functools.partial(capture_log, "trace", 1)
+debug = functools.partial(capture_log, "debug", 5)
+info = functools.partial(capture_log, "info", 9)
+warn = functools.partial(capture_log, "warn", 13)
+error = functools.partial(capture_log, "error", 17)
+fatal = functools.partial(capture_log, "fatal", 21)