ref: Add span filtering to span first

Author: sentrivana

sentry_sdk/_types.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, TypeVar, Union
+from typing import TYPE_CHECKING, Pattern, TypeVar, Union
 
 
 # Re-exported for compat, since code out there in the wild might use this variable.
@@ -361,3 +361,11 @@ class SDKInfo(TypedDict):
     class TextPart(TypedDict):
         type: Literal["text"]
         content: str
+
+    IgnoreSpansName = Union[str, Pattern[str]]
+    IgnoreSpansContext = TypedDict(
+        "IgnoreSpansContext",
+        {"name": IgnoreSpansName, "attributes": Attributes},
+        total=False,
+    )
+    IgnoreSpansConfig = list[Union[IgnoreSpansName, IgnoreSpansContext]]

sentry_sdk/consts.py

@@ -35,6 +35,7 @@ class CompressionAlgo(Enum):
         Any,
         Callable,
         Dict,
+        IgnoreSpansConfig,
         List,
         Optional,
         Sequence,
@@ -83,6 +84,7 @@ class CompressionAlgo(Enum):
             "enable_metrics": Optional[bool],
             "before_send_metric": Optional[Callable[[Metric, Hint], Optional[Metric]]],
             "trace_lifecycle": Optional[Literal["static", "stream"]],
+            "ignore_spans": Optional[IgnoreSpansConfig],
         },
         total=False,
     )

sentry_sdk/scope.py

@@ -30,6 +30,7 @@
     Baggage,
     has_tracing_enabled,
     has_span_streaming_enabled,
+    is_ignored_span,
     _make_sampling_decision,
     normalize_incoming_data,
     PropagationContext,
@@ -1207,6 +1208,12 @@ def start_streamed_span(
         if parent_span is None:
             propagation_context = self.get_active_propagation_context()
 
+            if is_ignored_span(name, attributes):
+                return NoOpStreamedSpan(
+                    scope=self,
+                    unsampled_reason="ignored",
+                )
+
             sampled, sample_rate, sample_rand, outcome = _make_sampling_decision(
                 name,
                 attributes,
@@ -1238,6 +1245,11 @@ def start_streamed_span(
 
         # This is a child span; take propagation context from the parent span
         with new_scope():
+            if is_ignored_span(name, attributes):
+                return NoOpStreamedSpan(
+                    unsampled_reason="ignored",
+                )
+
             if isinstance(parent_span, NoOpStreamedSpan):
                 return NoOpStreamedSpan(unsampled_reason=parent_span._unsampled_reason)
 

sentry_sdk/tracing_utils.py

@@ -8,6 +8,7 @@
 from collections.abc import Mapping, MutableMapping
 from datetime import timedelta
 from random import Random
+from typing import Pattern
 from urllib.parse import quote, unquote
 import uuid
 
@@ -1478,6 +1479,52 @@ def _make_sampling_decision(
     return sampled, sample_rate, sample_rand, outcome
 
 
+def is_ignored_span(name: str, attributes: "Optional[Attributes]") -> bool:
+    """Determine if a span fits one of the rules in ignore_spans."""
+    client = sentry_sdk.get_client()
+    ignore_spans = (client.options.get("_experiments") or {}).get("ignore_spans")
+
+    if not ignore_spans:
+        return False
+
+    def _matches(rule: "Any", value: "Any") -> bool:
+        if isinstance(rule, Pattern):
+            if isinstance(value, str):
+                return bool(rule.match(value))
+            else:
+                return False
+
+        return rule == value
+
+    for rule in ignore_spans:
+        if isinstance(rule, (str, Pattern)):
+            if _matches(rule, name):
+                return True
+
+        elif isinstance(rule, dict) and rule:
+            name_matches = True
+            attributes_match = True
+
+            if "name" in rule:
+                name_matches = _matches(rule["name"], name)
+
+            if "attributes" in rule:
+                if not attributes:
+                    attributes_match = False
+                else:
+                    for attribute, value in rule["attributes"].items():
+                        if attribute not in attributes or not _matches(
+                            value, attributes[attribute]
+                        ):
+                            attributes_match = False
+                            break
+
+            if name_matches and attributes_match:
+                return True
+
+    return False
+
+
 # Circular imports
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,