camel the item

Author: colin-sentry

sentry_sdk/_types.py

@@ -207,7 +207,17 @@ class SDKInfo(TypedDict):
     ]
 
     Hint = Dict[str, Any]
-    Log = Dict[str, Any]
+    Log = TypedDict(
+        "Log",
+        {
+            "severity_text": str,
+            "severity_number": int,
+            "body": str,
+            "attributes": dict[str, str | bool | float | int],
+            "time_unix_nano": int,
+            "trace_id": Optional[str],
+        },
+    )
 
     Breadcrumb = Dict[str, Any]
     BreadcrumbHint = Dict[str, Any]

sentry_sdk/client.py

@@ -57,7 +57,7 @@
     from typing import Union
     from typing import TypeVar
 
-    from sentry_sdk._types import Event, Hint, SDKInfo
+    from sentry_sdk._types import Event, Hint, SDKInfo, Log
     from sentry_sdk.integrations import Integration
     from sentry_sdk.metrics import MetricsAggregator
     from sentry_sdk.scope import Scope
@@ -862,17 +862,6 @@ def capture_log(self, scope, severity_text, severity_number, template, **kwargs)
             "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,
         }
@@ -885,6 +874,7 @@ def format_attribute(key: str, val: int | float | str | bool):
         for k, v in kwargs.items():
             attrs[f"sentry.message.parameters.{k}"] = v
 
+        # type: Log
         log = {
             "severity_text": severity_text,
             "severity_number": severity_number,
@@ -901,20 +891,40 @@ def format_attribute(key: str, val: int | float | str | bool):
         before_send_log = self.options.get("before_send_log")
         if before_send_log is not None:
             log = before_send_log(log)
+        if log is None:
+            return
 
-        # 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
+        def format_attribute(key, val):
+            # type: (str, int | float | str | bool) -> Any
+            if isinstance(val, int):
+                return {"key": key, "value": {"intValue": val}}
+            if isinstance(val, str):
+                return {"key": key, "value": {"stringValue": val}}
+            if isinstance(val, float):
+                return {"key": key, "value": {"doubleValue": val}}
+            if isinstance(val, bool):
+                return {"key": key, "value": {"boolValue": val}}
+            return {"key": key, "value": {"stringValue": json.dumps(val)}}
+
+        otel_log = {
+            "severityText": log["severity_text"],
+            "severityNumber": log["severity_number"],
+            "body": {"stringValue": log["body"]},
+            "timeUnixNano": str(log["time_unix_nano"]),
+        }
+        if isinstance((attrs := log["attributes"]), dict):
+            otel_log["attributes"] = [
+                format_attribute(k, v) for (k, v) in attrs.items()
+            ]
+        if "trace_id" in log:
+            otel_log["traceId"] = log["trace_id"]
+
+        envelope.add_log(otel_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/envelope.py

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

sentry_sdk/logger.py

@@ -1,15 +1,15 @@
 # NOTE: this is the logger sentry exposes to users, not some generic logger.
 import functools
-from typing import Any, Optional
+from typing import Any
 
 from sentry_sdk import get_client, get_current_scope
 
 
 def capture_log(severity_text, severity_number, template, **kwargs):
-    # type: (str, int, str, **Any) -> Optional[str]
+    # type: (str, int, str, **Any) -> None
     client = get_client()
     scope = get_current_scope()
-    return client.capture_log(scope, severity_text, severity_number, template, **kwargs)
+    client.capture_log(scope, severity_text, severity_number, template, **kwargs)
 
 
 trace = functools.partial(capture_log, "trace", 1)