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

Author: sl0thentr0py

sentry_sdk/integrations/opentelemetry/integration.py

@@ -44,6 +44,7 @@ def setup_once():
             "Use at your own risk."
         )
 
+        _setup_scope_context_management()
         _setup_sentry_tracing()
         _patch_readable_span()
         # _setup_instrumentors()
@@ -68,12 +69,15 @@ def sentry_patched_readable_span(self):
     Span._readable_span = sentry_patched_readable_span
 
 
-def _setup_sentry_tracing():
+def _setup_scope_context_management():
     # type: () -> None
     import opentelemetry.context
 
     opentelemetry.context._RUNTIME_CONTEXT = SentryContextVarsRuntimeContext()
 
+
+def _setup_sentry_tracing():
+    # type: () -> None
     provider = TracerProvider(sampler=SentrySampler())
     provider.add_span_processor(PotelSentrySpanProcessor())
     trace.set_tracer_provider(provider)

sentry_sdk/integrations/opentelemetry/sampler.py

@@ -34,10 +34,14 @@ def get_parent_sampled(parent_context, trace_id):
     # Only inherit sample rate if `traceId` is the same
     if is_span_context_valid and parent_context.trace_id == trace_id:
         # this is getSamplingDecision in JS
+        # if there was no sampling flag, defer the decision
+        dsc_sampled = parent_context.trace_state.get(TRACESTATE_SAMPLED_KEY)
+        if dsc_sampled == "deferred":
+            return None
+
         if parent_context.trace_flags.sampled is not None:
             return parent_context.trace_flags.sampled
 
-        dsc_sampled = parent_context.trace_state.get(TRACESTATE_SAMPLED_KEY)
         if dsc_sampled == "true":
             return True
         elif dsc_sampled == "false":
@@ -53,6 +57,8 @@ def dropped_result(parent_span_context, attributes, sample_rate=None):
 
     if TRACESTATE_SAMPLED_KEY not in trace_state:
         trace_state = trace_state.add(TRACESTATE_SAMPLED_KEY, "false")
+    elif trace_state.get(TRACESTATE_SAMPLED_KEY) == "deferred":
+        trace_state = trace_state.update(TRACESTATE_SAMPLED_KEY, "false")
 
     if sample_rate and TRACESTATE_SAMPLE_RATE_KEY not in trace_state:
         trace_state = trace_state.add(TRACESTATE_SAMPLE_RATE_KEY, str(sample_rate))
@@ -88,6 +94,9 @@ def sampled_result(span_context, attributes, sample_rate):
 
     if TRACESTATE_SAMPLED_KEY not in trace_state:
         trace_state = trace_state.add(TRACESTATE_SAMPLED_KEY, "true")
+    elif trace_state.get(TRACESTATE_SAMPLED_KEY) == "deferred":
+        trace_state = trace_state.update(TRACESTATE_SAMPLED_KEY, "true")
+
     if TRACESTATE_SAMPLE_RATE_KEY not in trace_state:
         trace_state = trace_state.add(TRACESTATE_SAMPLE_RATE_KEY, str(sample_rate))
 

sentry_sdk/integrations/opentelemetry/scope.py

@@ -6,6 +6,7 @@
     SpanContext,
     NonRecordingSpan,
     TraceFlags,
+    TraceState,
     use_span,
 )
 
@@ -14,6 +15,7 @@
     SENTRY_FORK_ISOLATION_SCOPE_KEY,
     SENTRY_USE_CURRENT_SCOPE_KEY,
     SENTRY_USE_ISOLATION_SCOPE_KEY,
+    TRACESTATE_SAMPLED_KEY,
 )
 from sentry_sdk.integrations.opentelemetry.utils import trace_state_from_baggage
 from sentry_sdk.scope import Scope, ScopeType
@@ -96,10 +98,15 @@ def _incoming_otel_span_context(self):
             else TraceFlags.DEFAULT
         )
 
-        # TODO-neel-potel do we need parent and sampled like JS?
-        trace_state = None
         if self._propagation_context.baggage:
             trace_state = trace_state_from_baggage(self._propagation_context.baggage)
+        else:
+            trace_state = TraceState()
+
+        # for twp to work, we also need to consider deferred sampling when the sampling
+        # flag is not present, so the above TraceFlags are not sufficient
+        if self._propagation_context.parent_sampled is None:
+            trace_state = trace_state.add(TRACESTATE_SAMPLED_KEY, "deferred")
 
         span_context = SpanContext(
             trace_id=int(self._propagation_context.trace_id, 16),  # type: ignore

sentry_sdk/scope.py

@@ -376,7 +376,7 @@ def get_client(cls):
         This checks the current scope, the isolation scope and the global scope for a client.
         If no client is available a :py:class:`sentry_sdk.client.NonRecordingClient` is returned.
         """
-        current_scope = cls._get_current_scope()
+        current_scope = cls.get_current_scope()
         try:
             client = current_scope.client
         except AttributeError:
@@ -385,7 +385,7 @@ def get_client(cls):
         if client is not None and client.is_active():
             return client
 
-        isolation_scope = cls._get_isolation_scope()
+        isolation_scope = cls.get_isolation_scope()
         try:
             client = isolation_scope.client
         except AttributeError:

sentry_sdk/tracing.py

@@ -1311,6 +1311,8 @@ def __exit__(self, ty, value, tb):
         # type: (Optional[Any], Optional[Any], Optional[Any]) -> None
         if value is not None:
             self.set_status(SPANSTATUS.INTERNAL_ERROR)
+        else:
+            self.set_status(SPANSTATUS.OK)
 
         self.finish()
         context.detach(self._ctx_token)

tests/integrations/opentelemetry/test_compat.py

@@ -9,7 +9,7 @@ def test_transaction_name_span_description_compat(
 
     events = capture_events()
 
-    with sentry_sdk.start_transaction(
+    with sentry_sdk.start_span(
         name="trx-name",
         op="trx-op",
     ) as trx:
@@ -33,13 +33,12 @@ def test_transaction_name_span_description_compat(
     assert spn.__class__.__name__ == "POTelSpan"
     assert spn.op == "span-op"
     assert spn.description == "span-desc"
-    assert spn.name is None
+    assert spn.name == "span-desc"
 
     assert spn._otel_span is not None
     assert spn._otel_span.name == "span-desc"
     assert spn._otel_span.attributes["sentry.op"] == "span-op"
     assert spn._otel_span.attributes["sentry.description"] == "span-desc"
-    assert "sentry.name" not in spn._otel_span.attributes
 
     transaction = events[0]
     assert transaction["transaction"] == "trx-name"
@@ -53,4 +52,3 @@ def test_transaction_name_span_description_compat(
     assert span["op"] == "span-op"
     assert span["data"]["sentry.op"] == "span-op"
     assert span["data"]["sentry.description"] == "span-desc"
-    assert "sentry.name" not in span["data"]

tests/integrations/opentelemetry/test_experimental.py

@@ -1,8 +1,8 @@
 import pytest
-
 from opentelemetry import trace
 
 import sentry_sdk
+from tests.conftest import ApproxDict
 
 
 tracer = trace.get_tracer(__name__)
@@ -43,7 +43,6 @@ def test_root_span_transaction_payload_started_with_otel_only(capture_envelopes)
     assert "span_id" in trace_context
     assert trace_context["origin"] == "manual"
     assert trace_context["op"] == "request"
-    assert trace_context["status"] == "ok"
 
     assert payload["spans"] == []
 
@@ -63,7 +62,6 @@ def test_child_span_payload_started_with_otel_only(capture_envelopes):
     assert span["op"] == "db"
     assert span["description"] == "db"
     assert span["origin"] == "manual"
-    assert span["status"] == "ok"
     assert span["span_id"] is not None
     assert span["trace_id"] == payload["contexts"]["trace"]["trace_id"]
     assert span["parent_span_id"] == payload["contexts"]["trace"]["span_id"]
@@ -222,8 +220,8 @@ def test_span_attributes_in_data_started_with_otel(capture_envelopes):
     (item,) = envelope.items
     payload = item.payload.json
 
-    assert payload["contexts"]["trace"]["data"] == {"foo": "bar", "baz": 42}
-    assert payload["spans"][0]["data"] == {"abc": 99, "def": "moo"}
+    assert payload["contexts"]["trace"]["data"] == ApproxDict({"foo": "bar", "baz": 42})
+    assert payload["spans"][0]["data"] == ApproxDict({"abc": 99, "def": "moo"})
 
 
 def test_span_data_started_with_sentry(capture_envelopes):
@@ -238,18 +236,22 @@ def test_span_data_started_with_sentry(capture_envelopes):
     (item,) = envelope.items
     payload = item.payload.json
 
-    assert payload["contexts"]["trace"]["data"] == {
-        "foo": "bar",
-        "sentry.origin": "manual",
-        "sentry.description": "request",
-        "sentry.op": "http",
-    }
-    assert payload["spans"][0]["data"] == {
-        "baz": 42,
-        "sentry.origin": "manual",
-        "sentry.description": "statement",
-        "sentry.op": "db",
-    }
+    assert payload["contexts"]["trace"]["data"] == ApproxDict(
+        {
+            "foo": "bar",
+            "sentry.origin": "manual",
+            "sentry.description": "request",
+            "sentry.op": "http",
+        }
+    )
+    assert payload["spans"][0]["data"] == ApproxDict(
+        {
+            "baz": 42,
+            "sentry.origin": "manual",
+            "sentry.description": "statement",
+            "sentry.op": "db",
+        }
+    )
 
 
 def test_transaction_tags_started_with_otel(capture_envelopes):