rename to exclude

Author: sentrivana

sentry_sdk/consts.py

@@ -649,7 +649,7 @@ def __init__(
         trace_propagation_targets=[  # noqa: B006
             MATCH_ALL
         ],  # type: Optional[Sequence[str]]
-        disabled_span_origins=None,  # type: Optional[Sequence[str]]
+        exclude_span_origins=None,  # type: Optional[Sequence[str]]
         functions_to_trace=[],  # type: Sequence[Dict[str, str]]  # noqa: B006
         event_scrubber=None,  # type: Optional[sentry_sdk.scrubber.EventScrubber]
         max_value_length=DEFAULT_MAX_VALUE_LENGTH,  # type: int
@@ -981,11 +981,11 @@ def __init__(
             If `trace_propagation_targets` is not provided, trace data is attached to every outgoing request from the
             instrumented client.
 
-        :param disabled_span_origins: An optional list of strings or regex patterns to disable span creation based
+        :param exclude_span_origins: An optional list of strings or regex patterns to exclude span creation based
             on span origin. When a span's origin would match any of the provided patterns, the span will not be
             created.
 
-            This can be useful to disable automatic span creation from specific integrations without disabling the
+            This can be useful to exclude automatic span creation from specific integrations without disabling the
             entire integration.
 
             The option may contain a list of strings or regexes against which the span origins are matched.

sentry_sdk/tracing.py

@@ -39,7 +39,7 @@
 )
 from sentry_sdk.tracing_utils import (
     get_span_status_from_http_code,
-    is_span_origin_disabled,
+    _is_span_origin_disabled,
 )
 from sentry_sdk.utils import (
     _serialize_span_attribute,
@@ -208,7 +208,7 @@ def __init__(
                     not parent_span_context.is_valid or parent_span_context.is_remote
                 )
 
-            if not skip_span and is_span_origin_disabled(origin):
+            if not skip_span and _is_span_origin_disabled(origin):
                 skip_span = True
 
             if skip_span:

sentry_sdk/tracing_utils.py

@@ -689,20 +689,20 @@ def should_propagate_trace(client, url):
     return match_regex_list(url, trace_propagation_targets, substring_matching=True)
 
 
-def is_span_origin_disabled(origin):
+def _is_span_origin_disabled(origin):
     # type: (Optional[str]) -> bool
     """
-    Check if spans with this origin should be ignored.
+    Check if spans with this origin should be ignored based on the `exclude_span_origins` option.
     """
     if origin is None:
         return False
 
     client = sentry_sdk.get_client()
-    disabled_span_origins = client.options.get("disabled_span_origins")
-    if not disabled_span_origins:
+    exclude_span_origins = client.options.get("exclude_span_origins")
+    if not exclude_span_origins:
         return False
 
-    return match_regex_list(origin, disabled_span_origins, substring_matching=True)
+    return match_regex_list(origin, exclude_span_origins, substring_matching=True)
 
 
 def normalize_incoming_data(incoming_data):

tests/tracing/test_span_origin.py

@@ -39,14 +39,11 @@ def test_span_origin_custom(sentry_init, capture_events):
     assert second_transaction["spans"][0]["origin"] == "baz.baz2.baz3"
 
 
-@pytest.mark.parametrize("disabled_origins", [None, [], "noop"])
-def test_disabled_span_origins_empty_config(
-    sentry_init, capture_events, disabled_origins
-):
-    """Test that when disabled_span_origins is None or empty, all spans are allowed."""
-    if disabled_origins in (None, []):
-        sentry_init(traces_sample_rate=1.0, disabled_span_origins=disabled_origins)
-    elif disabled_origins == "noop":
+@pytest.mark.parametrize("excluded_origins", [None, [], "noop"])
+def test_exclude_span_origins_empty(sentry_init, capture_events, excluded_origins):
+    if excluded_origins in (None, []):
+        sentry_init(traces_sample_rate=1.0, exclude_span_origins=excluded_origins)
+    elif excluded_origins == "noop":
         sentry_init(
             traces_sample_rate=1.0,
             # default is None
@@ -65,7 +62,7 @@ def test_disabled_span_origins_empty_config(
 
 
 @pytest.mark.parametrize(
-    "disabled_origins,origins,expected_events_count,expected_allowed_origins",
+    "excluded_origins,origins,expected_events_count,expected_allowed_origins",
     [
         # Regexes
         (
@@ -105,18 +102,17 @@ def test_disabled_span_origins_empty_config(
         ),
     ],
 )
-def test_disabled_span_origins_filtering(
+def test_exclude_span_origins_patterns(
     sentry_init,
     capture_events,
-    disabled_origins,
+    excluded_origins,
     origins,
     expected_events_count,
     expected_allowed_origins,
 ):
-    """Test disabled_span_origins with various pattern configurations."""
     sentry_init(
         traces_sample_rate=1.0,
-        disabled_span_origins=disabled_origins,
+        exclude_span_origins=excluded_origins,
     )
 
     events = capture_events()
@@ -134,8 +130,8 @@ def test_disabled_span_origins_filtering(
         assert captured_origins == set(expected_allowed_origins)
 
 
-def test_disabled_span_origins_with_child_spans(sentry_init, capture_events):
-    sentry_init(traces_sample_rate=1.0, disabled_span_origins=[r"auto\.http\..*"])
+def test_exclude_span_origins_with_child_spans(sentry_init, capture_events):
+    sentry_init(traces_sample_rate=1.0, exclude_span_origins=[r"auto\.http\..*"])
     events = capture_events()
 
     with start_span(name="parent", origin="manual"):
@@ -150,8 +146,8 @@ def test_disabled_span_origins_with_child_spans(sentry_init, capture_events):
     assert events[0]["spans"][0]["origin"] == "auto.db.postgres"
 
 
-def test_disabled_span_origin_parent_with_child_spans(sentry_init, capture_events):
-    sentry_init(traces_sample_rate=1.0, disabled_span_origins=[r"auto\.http\..*"])
+def test_exclude_span_origins_parent_with_child_spans(sentry_init, capture_events):
+    sentry_init(traces_sample_rate=1.0, exclude_span_origins=[r"auto\.http\..*"])
     events = capture_events()
 
     with start_span(name="parent", origin="auto.http.requests"):