Item instead of dictionary argument

Author: alexander-alderman-webb

sentry_sdk/_log_batcher.py

@@ -83,10 +83,21 @@ def add(
 
         with self._lock:
             if len(self._log_buffer) >= self.MAX_LOGS_BEFORE_DROP:
+                # Construct log envelope item without sending it to report lost bytes
+                log_item = Item(
+                    type="log",
+                    content_type="application/vnd.sentry.items.log+json",
+                    headers={
+                        "item_count": 1,
+                    },
+                    payload=PayloadRef(
+                        json={"items": [LogBatcher._log_to_transport_format(log)]}
+                    ),
+                )
                 self._record_lost_func(
                     reason="queue_overflow",
                     data_category="log_item",
-                    item=LogBatcher._log_to_transport_format(log),
+                    item=log_item,
                     quantity=1,
                 )
                 return None

sentry_sdk/client.py

@@ -62,7 +62,15 @@
     from typing import Union
     from typing import TypeVar
 
-    from sentry_sdk._types import Event, Hint, SDKInfo, Log, Metric, EventDataCategory
+    from sentry_sdk._types import (
+        Event,
+        Hint,
+        SDKInfo,
+        Log,
+        Metric,
+        EventDataCategory,
+        Item,
+    )
     from sentry_sdk.integrations import Integration
     from sentry_sdk.scope import Scope
     from sentry_sdk.session import Session
@@ -360,13 +368,15 @@ def _capture_envelope(envelope):
         def _record_lost_event(
             reason,  # type: str
             data_category,  # type: EventDataCategory
+            item,  # type: Item
             quantity=1,  # type: int
         ):
             # type: (...) -> None
             if self.transport is not None:
                 self.transport.record_lost_event(
                     reason=reason,
                     data_category=data_category,
+                    item=item,
                     quantity=quantity,
                 )
 

tests/test_logs.py

@@ -9,7 +9,7 @@
 import sentry_sdk
 import sentry_sdk.logger
 from sentry_sdk import get_client
-from sentry_sdk.envelope import Envelope
+from sentry_sdk.envelope import Envelope, Item, PayloadRef
 from sentry_sdk.types import Log
 from sentry_sdk.consts import SPANDATA, VERSION
 
@@ -471,51 +471,60 @@ def record_lost_event(reason, data_category=None, item=None, *, quantity=1):
 
     assert len(lost_event_calls) == 5
 
-    expected_dropped_item = {
-        "body": "This is a 'info' log...",
-        "level": "info",
-        "timestamp": mock.ANY,
-        "trace_id": mock.ANY,
-        "attributes": {
-            "sentry.environment": {
-                "type": "string",
-                "value": "production",
-            },
-            "sentry.release": {
-                "type": "string",
-                "value": "1.0.0",
-            },
-            "sentry.sdk.name": {
-                "type": "string",
-                "value": mock.ANY,
-            },
-            "sentry.sdk.version": {
-                "type": "string",
-                "value": VERSION,
-            },
-            "sentry.severity_number": {
-                "type": "integer",
-                "value": 9,
-            },
-            "sentry.severity_text": {
-                "type": "string",
-                "value": "info",
-            },
-            "sentry.trace.parent_span_id": {
-                "type": "string",
-                "value": mock.ANY,
-            },
-            "server.address": {
-                "type": "string",
-                "value": "test-server",
-            },
-        },
-    }
-
     for lost_event_call in lost_event_calls:
-        assert lost_event_call == (
-            "queue_overflow",
-            "log_item",
-            expected_dropped_item,
-            1,
-        )
+        reason, data_category, item, quantity = lost_event_call
+
+        assert reason == "queue_overflow"
+        assert data_category == "log_item"
+        assert quantity == 1
+
+        assert item.type == "log"
+        assert item.headers == {
+            "type": "log",
+            "item_count": 1,
+            "content_type": "application/vnd.sentry.items.log+json",
+        }
+        assert item.payload.json == {
+            "items": [
+                {
+                    "body": "This is a 'info' log...",
+                    "level": "info",
+                    "timestamp": mock.ANY,
+                    "trace_id": mock.ANY,
+                    "attributes": {
+                        "sentry.environment": {
+                            "type": "string",
+                            "value": "production",
+                        },
+                        "sentry.release": {
+                            "type": "string",
+                            "value": "1.0.0",
+                        },
+                        "sentry.sdk.name": {
+                            "type": "string",
+                            "value": mock.ANY,
+                        },
+                        "sentry.sdk.version": {
+                            "type": "string",
+                            "value": VERSION,
+                        },
+                        "sentry.severity_number": {
+                            "type": "integer",
+                            "value": 9,
+                        },
+                        "sentry.severity_text": {
+                            "type": "string",
+                            "value": "info",
+                        },
+                        "sentry.trace.parent_span_id": {
+                            "type": "string",
+                            "value": mock.ANY,
+                        },
+                        "server.address": {
+                            "type": "string",
+                            "value": "test-server",
+                        },
+                    },
+                }
+            ]
+        }