Remove scope.span = setter and make sure scope.span reference is

correct in context manager regardless of source of span.

Author: sl0thentr0py

MIGRATION_GUIDE.md

@@ -168,6 +168,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   - `span_id`
   - `parent_span_id`: you can supply a `parent_span` instead
 - The `Scope.transaction` property has been removed. To obtain the root span (previously transaction), use `Scope.root_span`. To set the root span's (transaction's) name, use `Scope.set_transaction_name()`.
+- The `Scope.span =` setter has been removed.
 - Passing a list or `None` for `failed_request_status_codes` in the Starlette integration is no longer supported. Pass a set of integers instead.
 - The `span` argument of `Scope.trace_propagation_meta` is no longer supported.
 - Setting `Scope.user` directly is no longer supported. Use `Scope.set_user()` instead.

sentry_sdk/integrations/celery/__init__.py

@@ -100,9 +100,9 @@ def setup_once():
 def _set_status(status):
     # type: (str) -> None
     with capture_internal_exceptions():
-        scope = sentry_sdk.get_current_scope()
-        if scope.span is not None:
-            scope.span.set_status(status)
+        span = sentry_sdk.get_current_span()
+        if span is not None:
+            span.set_status(status)
 
 
 def _capture_exception(task, exc_info):

sentry_sdk/opentelemetry/contextvars_context.py

@@ -1,10 +1,12 @@
 from typing import cast, TYPE_CHECKING
 
-from opentelemetry.trace import set_span_in_context
+from opentelemetry.trace import get_current_span, set_span_in_context
+from opentelemetry.trace.span import INVALID_SPAN
 from opentelemetry.context import Context, get_value, set_value
 from opentelemetry.context.contextvars_context import ContextVarsRuntimeContext
 
 import sentry_sdk
+from sentry_sdk.tracing import Span
 from sentry_sdk.opentelemetry.consts import (
     SENTRY_SCOPES_KEY,
     SENTRY_FORK_ISOLATION_SCOPE_KEY,
@@ -60,6 +62,12 @@ def attach(self, context):
         else:
             new_scope = current_scope.fork()
 
+            # carry forward a wrapped span reference since the otel context is always the
+            # source of truth for the active span
+            current_span = get_current_span(context)
+            if current_span != INVALID_SPAN:
+                new_scope._span = Span(otel_span=get_current_span(context))
+
         if should_use_isolation_scope:
             new_isolation_scope = should_use_isolation_scope
         elif should_fork_isolation_scope:

sentry_sdk/scope.py

@@ -732,12 +732,6 @@ def span(self):
         """Get current tracing span."""
         return self._span
 
-    @span.setter
-    def span(self, span):
-        # type: (Optional[Span]) -> None
-        """Set current tracing span."""
-        self._span = span
-
     @property
     def profile(self):
         # type: () -> Optional[Profile]

sentry_sdk/tracing.py

@@ -15,7 +15,6 @@
 from opentelemetry.sdk.trace import ReadableSpan
 from opentelemetry.version import __version__ as otel_version
 
-import sentry_sdk
 from sentry_sdk.consts import (
     DEFAULT_SPAN_NAME,
     DEFAULT_SPAN_ORIGIN,
@@ -280,10 +279,6 @@ def __enter__(self):
         # set as the implicit current context
         self._ctx_token = context.attach(ctx)
 
-        # get the new scope that was forked on context.attach
-        self.scope = sentry_sdk.get_current_scope()
-        self.scope.span = self
-
         return self
 
     def __exit__(self, ty, value, tb):

tests/integrations/rust_tracing/test_rust_tracing.py

@@ -176,7 +176,7 @@ def test_nested_on_new_span_on_close(sentry_init, capture_events):
     assert "version" not in second_span_data
 
 
-def test_on_new_span_without_transaction(sentry_init):
+def test_no_spans_without_transaction(sentry_init):
     rust_tracing = FakeRustTracing()
     integration = RustTracingIntegration(
         "test_on_new_span_without_transaction", rust_tracing.set_layer_impl
@@ -185,11 +185,9 @@ def test_on_new_span_without_transaction(sentry_init):
 
     assert sentry_sdk.get_current_span() is None
 
-    # Should still create a span hierarchy, it just will not be under a txn
     rust_tracing.new_span(RustTracingLevel.Info, 3)
     current_span = sentry_sdk.get_current_span()
-    assert current_span is not None
-    assert current_span.root_span is None
+    assert current_span is None
 
 
 def test_on_event_exception(sentry_init, capture_events):

tests/opentelemetry/test_context_scope_management.py

@@ -0,0 +1,24 @@
+from opentelemetry import trace
+
+import sentry_sdk
+from sentry_sdk.tracing import Span
+
+
+tracer = trace.get_tracer(__name__)
+
+
+def test_scope_span_reference_started_with_sentry(sentry_init):
+    sentry_init(traces_sample_rate=1.0)
+
+    with sentry_sdk.start_span(name="test") as span:
+        assert sentry_sdk.get_current_span() == span
+        assert sentry_sdk.get_current_scope().span == span
+
+
+def test_scope_span_reference_started_with_otel(sentry_init):
+    sentry_init(traces_sample_rate=1.0)
+
+    with tracer.start_as_current_span("test") as otel_span:
+        wrapped_span = Span(otel_span=otel_span)
+        assert sentry_sdk.get_current_span() == wrapped_span
+        assert sentry_sdk.get_current_scope().span == wrapped_span

tests/opentelemetry/test_potel.py

@@ -11,10 +11,7 @@
 
 @pytest.fixture(autouse=True)
 def sentry_init_potel(sentry_init):
-    sentry_init(
-        traces_sample_rate=1.0,
-        _experiments={"otel_powered_performance": True},
-    )
+    sentry_init(traces_sample_rate=1.0)
 
 
 def test_root_span_transaction_payload_started_with_otel_only(capture_envelopes):

tests/test_api.py

@@ -13,37 +13,13 @@
     start_span,
     set_tags,
     get_global_scope,
-    get_current_scope,
     get_isolation_scope,
 )
 
 from sentry_sdk.client import Client, NonRecordingClient
 from tests.conftest import SortedBaggage
 
 
-@pytest.mark.forked
-def test_get_current_span():
-    fake_scope = mock.MagicMock()
-    fake_scope.span = mock.MagicMock()
-    assert get_current_span(fake_scope) == fake_scope.span
-
-    fake_scope.span = None
-    assert get_current_span(fake_scope) is None
-
-
-@pytest.mark.forked
-def test_get_current_span_current_scope(sentry_init):
-    sentry_init()
-
-    assert get_current_span() is None
-
-    scope = get_current_scope()
-    fake_span = mock.MagicMock()
-    scope.span = fake_span
-
-    assert get_current_span() == fake_span
-
-
 @pytest.mark.forked
 def test_get_current_span_current_scope_with_span(sentry_init):
     sentry_init()