fix(spans): moving conversion to AnnotatedValue closer to serializer

Extend tests to check for correct `_meta` content.
Cleanup.

Author: constantinius

sentry_sdk/_types.py

@@ -78,6 +78,7 @@ class SDKInfo(TypedDict):
             "check_in_id": str,
             "contexts": dict[str, dict[str, object]],
             "dist": str,
+            "dropped_spans": int,
             "duration": Optional[float],
             "environment": str,
             "errors": list[dict[str, Any]],  # TODO: We can expand on this type

sentry_sdk/client.py

@@ -10,6 +10,7 @@
 
 from sentry_sdk._compat import PY37, check_uwsgi_thread_support
 from sentry_sdk.utils import (
+    AnnotatedValue,
     ContextVar,
     capture_internal_exceptions,
     current_stacktrace,
@@ -483,16 +484,14 @@ def _prepare_event(
     ):
         # type: (...) -> Optional[Event]
 
+        spans_delta = 0  # type: int
+
         if event.get("timestamp") is None:
             event["timestamp"] = datetime.now(timezone.utc)
 
         if scope is not None:
             is_transaction = event.get("type") == "transaction"
-            spans = event.get("spans", [])
-            from sentry_sdk.utils import AnnotatedValue
-            if isinstance(spans, AnnotatedValue):
-                spans = spans.value
-            spans_before = len(spans)
+            spans_before = len(event.get("spans", []))
             event_ = scope.apply_to_event(event, hint, self.options)
 
             # one of the event/error processors returned None
@@ -511,11 +510,7 @@ def _prepare_event(
                 return None
 
             event = event_
-
-            spans = event.get("spans", [])
-            if isinstance(spans, AnnotatedValue):
-                spans = spans.value
-            spans_delta = spans_before - len(spans)
+            spans_delta = spans_before - len(event.get("spans", []))
             if is_transaction and spans_delta > 0 and self.transport is not None:
                 self.transport.record_lost_event(
                     "event_processor", data_category="span", quantity=spans_delta
@@ -568,6 +563,11 @@ def _prepare_event(
             if event_scrubber:
                 event_scrubber.scrub_event(event)
 
+
+        dropped_spans = event.pop("dropped_spans", 0) + spans_delta # type: int
+        if dropped_spans > 0 or spans_delta > 0:
+            event["spans"] = AnnotatedValue(event.get("spans", []), {"len": spans_before + dropped_spans})
+
         # Postprocess the event here so that annotated types do
         # generally not surface in before_send
         if event is not None:

sentry_sdk/serializer.py

@@ -382,7 +382,6 @@ def _serialize_node_impl(
         serialized_event = _serialize_node(event, **kwargs)
         if not is_vars and meta_stack and isinstance(serialized_event, dict):
             serialized_event["_meta"] = meta_stack[0]
-        print(serialized_event["_meta"])
 
         return serialized_event
     finally:

sentry_sdk/tracing.py

@@ -11,7 +11,6 @@
     is_valid_sample_rate,
     logger,
     nanosecond_time,
-    AnnotatedValue
 )
 
 from typing import TYPE_CHECKING
@@ -204,7 +203,7 @@ def __init__(self, maxlen):
         # should be changed to match a consistent interpretation of what maxlen
         # limits: either transaction+spans or only child spans.
         self.maxlen = maxlen - 1
-        self.spans = []  # type: Union[List[Span], AnnotatedValue]
+        self.spans = []  # type: List[Span]
         self.dropped_spans = 0 # type: int
 
     def add(self, span):
@@ -215,42 +214,6 @@ def add(self, span):
         else:
             self.spans.append(span)
 
-    
-
-
-
-
-
-    # __slots__ = ("maxlen", "_spans")
-
-    # def __init__(self, maxlen):
-    #     # type: (int) -> None
-    #     # FIXME: this is `maxlen - 1` only to preserve historical behavior
-    #     # enforced by tests.
-    #     # Either this should be changed to `maxlen` or the JS SDK implementation
-    #     # should be changed to match a consistent interpretation of what maxlen
-    #     # limits: either transaction+spans or only child spans.
-    #     self.maxlen = maxlen - 1
-    #     self._spans = []  # type: Union[List[Span], AnnotatedValue]
-
-    # def add(self, span):
-    #     # type: (Span) -> None
-    #     if isinstance(self._spans, AnnotatedValue):
-    #         self._spans.metadata["len"] += 1
-    #     else:
-    #         if len(self._spans) > self.maxlen:
-    #             span._span_recorder = None
-    #             self._spans = AnnotatedValue(self._spans, {"len": self.maxlen}) # TODO!
-    #         else:
-    #             self._spans.append(span)
-
-    # @property
-    # def spans(self):
-    #     # type: () -> List[Span]
-    #     if isinstance(self._spans, AnnotatedValue):
-    #         return self._spans.value
-    #     return self._spans
-
 
 class Span:
     """A span holds timing information of a block of code.
@@ -1011,9 +974,8 @@ def finish(
             if span.timestamp is not None
         ]
 
-        len_diff = len(self._span_recorder.spans) - len(finished_spans)
-        if len_diff or self._span_recorder.dropped_spans:
-            finished_spans = AnnotatedValue(finished_spans, {"len": len_diff + self._span_recorder.dropped_spans})
+        len_diff = len(self._span_recorder.spans) - len(finished_spans)        
+        dropped_spans = len_diff + self._span_recorder.dropped_spans
 
         # we do this to break the circular reference of transaction -> span
         # recorder -> span -> containing transaction (which is where we started)
@@ -1039,6 +1001,9 @@ def finish(
             "spans": finished_spans,
         }  # type: Event
 
+        if dropped_spans > 0:
+            event["dropped_spans"] = dropped_spans
+
         if self._profile is not None and self._profile.valid():
             event["profile"] = self._profile
             self._profile = None

tests/tracing/test_misc.py

@@ -31,6 +31,8 @@ def test_span_trimming(sentry_init, capture_events):
     assert span2["op"] == "foo1"
     assert span3["op"] == "foo2"
 
+    assert event["_meta"]["spans"][""]["len"] == 10
+
 
 def test_transaction_naming(sentry_init, capture_events):
     sentry_init(traces_sample_rate=1.0)