Merge branch 'potel-base' into potel-base-run-all-tests

Author: antonpirker

MIGRATION_GUIDE.md

@@ -138,6 +138,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - `span.containing_transaction` has been removed. Use `span.root_span` instead.
 - `continue_from_headers`, `continue_from_environ` and `from_traceparent` have been removed, please use top-level API `sentry_sdk.continue_trace` instead.
 - `PropagationContext` constructor no longer takes a `dynamic_sampling_context` but takes a `baggage` object instead.
+- `ThreadingIntegration` no longer takes the `propagate_hub` argument.
 
 ### Deprecated
 

sentry_sdk/_init_implementation.py

@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING
 
 import sentry_sdk
+from sentry_sdk.integrations.opentelemetry.scope import setup_scope_context_management
 
 if TYPE_CHECKING:
     from typing import Any, Optional
@@ -24,6 +25,7 @@ def _init(*args, **kwargs):
     """
     client = sentry_sdk.Client(*args, **kwargs)
     sentry_sdk.get_global_scope().set_client(client)
+    setup_scope_context_management()
     _check_python_deprecations()
 
 

sentry_sdk/integrations/opentelemetry/contextvars_context.py

@@ -1,3 +1,6 @@
+from typing import cast, TYPE_CHECKING
+
+from opentelemetry.trace import set_span_in_context
 from opentelemetry.context import Context, get_value, set_value
 from opentelemetry.context.contextvars_context import ContextVarsRuntimeContext
 
@@ -9,25 +12,50 @@
     SENTRY_USE_ISOLATION_SCOPE_KEY,
 )
 
+if TYPE_CHECKING:
+    from typing import Optional
+    from sentry_sdk.integrations.opentelemetry.scope import PotelScope
+
 
 class SentryContextVarsRuntimeContext(ContextVarsRuntimeContext):
     def attach(self, context):
         # type: (Context) -> object
         scopes = get_value(SENTRY_SCOPES_KEY, context)
+
         should_fork_isolation_scope = context.pop(
             SENTRY_FORK_ISOLATION_SCOPE_KEY, False
         )
+        should_fork_isolation_scope = cast("bool", should_fork_isolation_scope)
+
         should_use_isolation_scope = context.pop(SENTRY_USE_ISOLATION_SCOPE_KEY, None)
+        should_use_isolation_scope = cast(
+            "Optional[PotelScope]", should_use_isolation_scope
+        )
+
         should_use_current_scope = context.pop(SENTRY_USE_CURRENT_SCOPE_KEY, None)
+        should_use_current_scope = cast(
+            "Optional[PotelScope]", should_use_current_scope
+        )
 
-        if scopes and isinstance(scopes, tuple):
+        if scopes:
+            scopes = cast("tuple[PotelScope, PotelScope]", scopes)
             (current_scope, isolation_scope) = scopes
         else:
             current_scope = sentry_sdk.get_current_scope()
             isolation_scope = sentry_sdk.get_isolation_scope()
 
+        new_context = context
+
         if should_use_current_scope:
             new_scope = should_use_current_scope
+
+            # the main case where we use use_scope is for
+            # scope propagation in the ThreadingIntegration
+            # so we need to carry forward the span reference explicitly too
+            span = should_use_current_scope.span
+            if span:
+                new_context = set_span_in_context(span._otel_span, new_context)
+
         else:
             new_scope = current_scope.fork()
 
@@ -40,5 +68,5 @@ def attach(self, context):
 
         new_scopes = (new_scope, new_isolation_scope)
 
-        new_context = set_value(SENTRY_SCOPES_KEY, new_scopes, context)
+        new_context = set_value(SENTRY_SCOPES_KEY, new_scopes, new_context)
         return super().attach(new_context)

sentry_sdk/integrations/opentelemetry/integration.py

@@ -5,14 +5,10 @@
 """
 
 from sentry_sdk.integrations import DidNotEnable, Integration
-from sentry_sdk.integrations.opentelemetry.scope import setup_initial_scopes
 from sentry_sdk.integrations.opentelemetry.propagator import SentryPropagator
 from sentry_sdk.integrations.opentelemetry.span_processor import (
     SentrySpanProcessor,
 )
-from sentry_sdk.integrations.opentelemetry.contextvars_context import (
-    SentryContextVarsRuntimeContext,
-)
 from sentry_sdk.integrations.opentelemetry.sampler import SentrySampler
 from sentry_sdk.utils import logger
 
@@ -45,7 +41,6 @@ def setup_once():
             "Use at your own risk."
         )
 
-        _setup_scope_context_management()
         _setup_sentry_tracing()
         _patch_readable_span()
         # _setup_instrumentors()
@@ -70,14 +65,6 @@ def sentry_patched_readable_span(self):
     Span._readable_span = sentry_patched_readable_span
 
 
-def _setup_scope_context_management():
-    # type: () -> None
-    import opentelemetry.context
-
-    opentelemetry.context._RUNTIME_CONTEXT = SentryContextVarsRuntimeContext()
-    setup_initial_scopes()
-
-
 def _setup_sentry_tracing():
     # type: () -> None
     provider = TracerProvider(sampler=SentrySampler())

sentry_sdk/integrations/opentelemetry/scope.py

@@ -2,7 +2,6 @@
 from contextlib import contextmanager
 
 from opentelemetry.context import (
-    Context,
     get_value,
     set_value,
     attach,
@@ -24,6 +23,9 @@
     SENTRY_USE_ISOLATION_SCOPE_KEY,
     TRACESTATE_SAMPLED_KEY,
 )
+from sentry_sdk.integrations.opentelemetry.contextvars_context import (
+    SentryContextVarsRuntimeContext,
+)
 from sentry_sdk.integrations.opentelemetry.utils import trace_state_from_baggage
 from sentry_sdk.scope import Scope, ScopeType
 from sentry_sdk.tracing import POTelSpan
@@ -152,6 +154,14 @@ def setup_initial_scopes():
     attach(set_value(SENTRY_SCOPES_KEY, scopes))
 
 
+def setup_scope_context_management():
+    # type: () -> None
+    import opentelemetry.context
+
+    opentelemetry.context._RUNTIME_CONTEXT = SentryContextVarsRuntimeContext()
+    setup_initial_scopes()
+
+
 @contextmanager
 def isolation_scope():
     # type: () -> Generator[Scope, None, None]

sentry_sdk/integrations/threading.py

@@ -7,7 +7,6 @@
 from sentry_sdk.utils import (
     event_from_exception,
     capture_internal_exceptions,
-    logger,
     reraise,
 )
 
@@ -27,22 +26,10 @@
 class ThreadingIntegration(Integration):
     identifier = "threading"
 
-    def __init__(self, propagate_hub=None, propagate_scope=True):
-        # type: (Optional[bool], bool) -> None
-        if propagate_hub is not None:
-            logger.warning(
-                "Deprecated: propagate_hub is deprecated. This will be removed in the future."
-            )
-
-        # Note: propagate_hub did not have any effect on propagation of scope data
-        # scope data was always propagated no matter what the value of propagate_hub was
-        # This is why the default for propagate_scope is True
-
+    def __init__(self, propagate_scope=True):
+        # type: (bool) -> None
         self.propagate_scope = propagate_scope
 
-        if propagate_hub is not None:
-            self.propagate_scope = propagate_hub
-
     @staticmethod
     def setup_once():
         # type: () -> None
@@ -99,7 +86,8 @@ def _run_old_run_func():
                 with sentry_sdk.use_scope(current_scope_to_use):
                     return _run_old_run_func()
         else:
-            return _run_old_run_func()
+            with sentry_sdk.isolation_scope():
+                return _run_old_run_func()
 
     return run  # type: ignore
 

sentry_sdk/scope.py

@@ -26,6 +26,7 @@
     SENTRY_TRACE_HEADER_NAME,
     NoOpSpan,
     Span,
+    POTelSpan,
     Transaction,
 )
 from sentry_sdk.utils import (
@@ -669,7 +670,7 @@ def clear(self):
         self.clear_breadcrumbs()
         self._should_capture = True  # type: bool
 
-        self._span = None  # type: Optional[Span]
+        self._span = None  # type: Optional[POTelSpan]
         self._session = None  # type: Optional[Session]
         self._force_auto_session_tracking = None  # type: Optional[bool]
 
@@ -777,13 +778,13 @@ def set_user(self, value):
 
     @property
     def span(self):
-        # type: () -> Optional[Span]
+        # type: () -> Optional[POTelSpan]
         """Get current tracing span."""
         return self._span
 
     @span.setter
     def span(self, span):
-        # type: (Optional[Span]) -> None
+        # type: (Optional[POTelSpan]) -> None
         """Set current tracing span."""
         self._span = span
 

sentry_sdk/tracing.py

@@ -1280,11 +1280,11 @@ def __eq__(self, other):
     def __repr__(self):
         # type: () -> str
         return (
-            "<%s(op=%r, description:%r, trace_id=%r, span_id=%r, parent_span_id=%r, sampled=%r, origin=%r)>"
+            "<%s(op=%r, name:%r, trace_id=%r, span_id=%r, parent_span_id=%r, sampled=%r, origin=%r)>"
             % (
                 self.__class__.__name__,
                 self.op,
-                self.description,
+                self.name,
                 self.trace_id,
                 self.span_id,
                 self.parent_span_id,

tests/conftest.py

@@ -62,7 +62,10 @@ def benchmark():
 
 
 from sentry_sdk import scope
-import sentry_sdk.integrations.opentelemetry.scope as potel_scope
+from sentry_sdk.integrations.opentelemetry.scope import (
+    setup_scope_context_management,
+    setup_initial_scopes,
+)
 
 
 @pytest.fixture(autouse=True)
@@ -74,7 +77,7 @@ def clean_scopes():
     scope._isolation_scope.set(None)
     scope._current_scope.set(None)
 
-    potel_scope.setup_initial_scopes()
+    setup_initial_scopes()
 
 
 @pytest.fixture(autouse=True)
@@ -187,6 +190,7 @@ def inner(*a, **kw):
         kw.setdefault("transport", TestTransport())
         client = sentry_sdk.Client(*a, **kw)
         sentry_sdk.get_global_scope().set_client(client)
+        setup_scope_context_management()
 
     if request.node.get_closest_marker("forked"):
         # Do not run isolation if the test is already running in

tests/integrations/opentelemetry/test_propagator.py

@@ -1,6 +1,5 @@
 import pytest
 
-from unittest import mock
 from unittest.mock import MagicMock
 
 from opentelemetry.trace.propagation import get_current_span
@@ -12,8 +11,6 @@
     SENTRY_TRACE_KEY,
 )
 from sentry_sdk.integrations.opentelemetry.propagator import SentryPropagator
-from sentry_sdk.integrations.opentelemetry.span_processor import SentrySpanProcessor
-from sentry_sdk.tracing_utils import Baggage
 
 
 @pytest.mark.forked
@@ -23,7 +20,7 @@ def test_extract_no_context_no_sentry_trace_header():
     Extract should return empty context.
     """
     carrier = None
-    context = None
+    context = {}
     getter = MagicMock()
     getter.get.return_value = None
 
@@ -144,8 +141,8 @@ def test_inject_continue_trace(sentry_init, SortedBaggage):
     with sentry_sdk.continue_trace(incoming_headers):
         with sentry_sdk.start_span(name="foo") as span:
             SentryPropagator().inject(carrier, setter=setter)
-            assert(carrier["sentry-trace"]) == f"{trace_id}-{span.span_id}-1"
-            assert(carrier["baggage"]) == SortedBaggage(baggage)
+            assert (carrier["sentry-trace"]) == f"{trace_id}-{span.span_id}-1"
+            assert (carrier["baggage"]) == SortedBaggage(baggage)
 
 
 def test_inject_head_sdk(sentry_init, SortedBaggage):
@@ -156,7 +153,7 @@ def test_inject_head_sdk(sentry_init, SortedBaggage):
 
     with sentry_sdk.start_span(name="foo") as span:
         SentryPropagator().inject(carrier, setter=setter)
-        assert(carrier["sentry-trace"]) == f"{span.trace_id}-{span.span_id}-1"
-        assert(carrier["baggage"]) == SortedBaggage(
+        assert (carrier["sentry-trace"]) == f"{span.trace_id}-{span.span_id}-1"
+        assert (carrier["baggage"]) == SortedBaggage(
             f"sentry-transaction=foo,sentry-release=release,sentry-environment=production,sentry-trace_id={span.trace_id},sentry-sample_rate=1.0,sentry-sampled=true"
         )