WIP: Potel sampling

MIGRATION_GUIDE.md

@@ -9,22 +9,26 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 
 ### Changed
 
+- The SDK now supports Python 3.7 and higher.
+- `sentry_sdk.start_span` now only takes keyword arguments.
 - The `Span()` constructor does not accept a `hub` parameter anymore.
 - `Span.finish()` does not accept a `hub` parameter anymore.
 - The `Profile()` constructor does not accept a `hub` parameter anymore.
 - A `Profile` object does not have a `.hub` property anymore.
 
 ### Removed
 
+- When setting span status, the HTTP status code is no longer automatically added as a tag.
 - Class `Hub` has been removed.
 - Class `_ScopeManager` has been removed.
 - The context manager `auto_session_tracking()` has been removed. Use `track_session()` instead.
 - The context manager `auto_session_tracking_scope()` has been removed. Use `track_session()` instead.
-- Utility function `is_auto_session_tracking_enabled()` has been removed. There is no public replacement. There is a private `_is_auto_session_tracking_enabled()` (if you absolutely need this function) It accepts a `scope` parameter instead of the previously used `hub` parameter. 
+- Utility function `is_auto_session_tracking_enabled()` has been removed. There is no public replacement. There is a private `_is_auto_session_tracking_enabled()` (if you absolutely need this function) It accepts a `scope` parameter instead of the previously used `hub` parameter.
 - Utility function `is_auto_session_tracking_enabled_scope()` has been removed. There is no public replacement. There is a private `_is_auto_session_tracking_enabled()` (if you absolutely need this function)
 
 ### Deprecated
 
+- `sentry_sdk.start_transaction` is deprecated. Use `sentry_sdk.start_span` instead.
 
 ## Upgrading to 2.0
 

sentry_sdk/api.py

@@ -2,10 +2,15 @@
 
 from sentry_sdk import tracing_utils, Client
 from sentry_sdk._init_implementation import init
-from sentry_sdk.scope import Scope, new_scope, isolation_scope
-from sentry_sdk.tracing import NoOpSpan, Transaction, trace
+from sentry_sdk.tracing import POTelSpan, Transaction, trace
 from sentry_sdk.crons import monitor
 
+# TODO-neel-potel make 2 scope strategies/impls and switch
+from sentry_sdk.integrations.opentelemetry.scope import (
+    PotelScope as Scope,
+    new_scope,
+    isolation_scope,
+)
 
 from sentry_sdk._types import TYPE_CHECKING
 
@@ -227,22 +232,40 @@ def flush(
     return get_client().flush(timeout=timeout, callback=callback)
 
 
-@scopemethod
 def start_span(
+    *,
+    span=None,
+    custom_sampling_context=None,
     **kwargs,  # type: Any
 ):
-    # type: (...) -> Span
-    return get_current_scope().start_span(**kwargs)
+    # type: (...) -> POTelSpan
+    """
+    Start and return a span.
+
+    This is the entry point to manual tracing instrumentation.
+
+    A tree structure can be built by adding child spans to the span.
+    To start a new child span within the span, call the `start_child()` method.
+
+    When used as a context manager, spans are automatically finished at the end
+    of the `with` block. If not using context managers, call the `finish()`
+    method.
+    """
+    # TODO: Consider adding type hints to the method signature.
+    return get_current_scope().start_span(span, custom_sampling_context, **kwargs)
 
 
-@scopemethod
 def start_transaction(
     transaction=None,  # type: Optional[Transaction]
     custom_sampling_context=None,  # type: Optional[SamplingContext]
     **kwargs,  # type: Unpack[TransactionKwargs]
 ):
-    # type: (...) -> Union[Transaction, NoOpSpan]
+    # type: (...) -> POTelSpan
     """
+    .. deprecated:: 3.0.0
+        This function is deprecated and will be removed in a future release.
+        Use :py:meth:`sentry_sdk.start_span` instead.
+
     Start and return a transaction on the current scope.
 
     Start an existing transaction if given, otherwise create and start a new
@@ -271,8 +294,10 @@ def start_transaction(
         constructor. See :py:class:`sentry_sdk.tracing.Transaction` for
         available arguments.
     """
-    return get_current_scope().start_transaction(
-        transaction, custom_sampling_context, **kwargs
+    return start_span(
+        span=transaction,
+        custom_sampling_context=custom_sampling_context,
+        **kwargs,
     )
 
 
@@ -311,10 +336,8 @@ def get_baggage():
     return None
 
 
-def continue_trace(
-    environ_or_headers, op=None, name=None, source=None, origin="manual"
-):
-    # type: (Dict[str, Any], Optional[str], Optional[str], Optional[str], str) -> Transaction
+def continue_trace(environ_or_headers, op=None, name=None, source=None, origin=None):
+    # type: (Dict[str, Any], Optional[str], Optional[str], Optional[str], Optional[str]) -> Transaction
     """
     Sets the propagation context from environment or headers and returns a transaction.
     """

sentry_sdk/integrations/asgi.py

@@ -96,9 +96,9 @@ def __init__(
         unsafe_context_data=False,
         transaction_style="endpoint",
         mechanism_type="asgi",
-        span_origin="manual",
+        span_origin=None,
     ):
-        # type: (Any, bool, str, str, str) -> None
+        # type: (Any, bool, str, str, Optional[str]) -> None
         """
         Instrument an ASGI application with Sentry. Provides HTTP/websocket
         data to sent events and basic handling for exceptions bubbling up

sentry_sdk/integrations/boto3.py

@@ -3,7 +3,6 @@
 import sentry_sdk
 from sentry_sdk.consts import OP, SPANDATA
 from sentry_sdk.integrations import Integration, DidNotEnable
-from sentry_sdk.tracing import Span
 
 from sentry_sdk._types import TYPE_CHECKING
 from sentry_sdk.utils import (
@@ -19,6 +18,8 @@
     from typing import Optional
     from typing import Type
 
+    from sentry_sdk.tracing import Span
+
 try:
     from botocore import __version__ as BOTOCORE_VERSION  # type: ignore
     from botocore.client import BaseClient  # type: ignore

sentry_sdk/integrations/opentelemetry/consts.py

@@ -1,7 +1,22 @@
 from opentelemetry.context import create_key
 
 
+# propagation keys
 SENTRY_TRACE_KEY = create_key("sentry-trace")
 SENTRY_BAGGAGE_KEY = create_key("sentry-baggage")
+
+# scope management keys
+SENTRY_SCOPES_KEY = create_key("sentry_scopes")
+SENTRY_FORK_ISOLATION_SCOPE_KEY = create_key("sentry_fork_isolation_scope")
+
 OTEL_SENTRY_CONTEXT = "otel"
 SPAN_ORIGIN = "auto.otel"
+
+
+class SentrySpanAttribute:
+    # XXX better name
+    # XXX not all of these need separate attributes, we might just use
+    # existing otel attrs for some
+    DESCRIPTION = "sentry.description"
+    OP = "sentry.op"
+    ORIGIN = "sentry.origin"

sentry_sdk/integrations/opentelemetry/contextvars_context.py

@@ -1,26 +1,32 @@
-from opentelemetry.context import Context, create_key, get_value, set_value
+from opentelemetry.context import Context, get_value, set_value
 from opentelemetry.context.contextvars_context import ContextVarsRuntimeContext
 
-from sentry_sdk.scope import Scope
-
-
-_SCOPES_KEY = create_key("sentry_scopes")
+import sentry_sdk
+from sentry_sdk.integrations.opentelemetry.consts import (
+    SENTRY_SCOPES_KEY,
+    SENTRY_FORK_ISOLATION_SCOPE_KEY,
+)
 
 
 class SentryContextVarsRuntimeContext(ContextVarsRuntimeContext):
     def attach(self, context):
         # type: (Context) -> object
-        scopes = get_value(_SCOPES_KEY, context)
+        scopes = get_value(SENTRY_SCOPES_KEY, context)
+        should_fork_isolation_scope = context.pop(
+            SENTRY_FORK_ISOLATION_SCOPE_KEY, False
+        )
 
         if scopes and isinstance(scopes, tuple):
             (current_scope, isolation_scope) = scopes
         else:
-            current_scope = Scope.get_current_scope()
-            isolation_scope = Scope.get_isolation_scope()
+            current_scope = sentry_sdk.get_current_scope()
+            isolation_scope = sentry_sdk.get_isolation_scope()
 
-        # TODO-neel-potel fork isolation_scope too like JS
-        # once we setup our own apis to pass through to otel
-        new_scopes = (current_scope.fork(), isolation_scope)
-        new_context = set_value(_SCOPES_KEY, new_scopes, context)
+        new_scope = current_scope.fork()
+        new_isolation_scope = (
+            isolation_scope.fork() if should_fork_isolation_scope else isolation_scope
+        )
+        new_scopes = (new_scope, new_isolation_scope)
 
+        new_context = set_value(SENTRY_SCOPES_KEY, new_scopes, context)
         return super().attach(new_context)

sentry_sdk/integrations/opentelemetry/integration.py

@@ -6,7 +6,13 @@
 
 from sentry_sdk.integrations import DidNotEnable, Integration
 from sentry_sdk.integrations.opentelemetry.propagator import SentryPropagator
-from sentry_sdk.integrations.opentelemetry.span_processor import SentrySpanProcessor
+from sentry_sdk.integrations.opentelemetry.potel_span_processor import (
+    PotelSentrySpanProcessor,
+)
+from sentry_sdk.integrations.opentelemetry.contextvars_context import (
+    SentryContextVarsRuntimeContext,
+)
+from sentry_sdk.integrations.opentelemetry.sampler import SentrySampler
 from sentry_sdk.utils import logger
 
 try:
@@ -46,9 +52,14 @@ def setup_once():
 
 def _setup_sentry_tracing():
     # type: () -> None
-    provider = TracerProvider()
-    provider.add_span_processor(SentrySpanProcessor())
+    import opentelemetry.context
+
+    opentelemetry.context._RUNTIME_CONTEXT = SentryContextVarsRuntimeContext()
+
+    provider = TracerProvider(sampler=SentrySampler())
+    provider.add_span_processor(PotelSentrySpanProcessor())
     trace.set_tracer_provider(provider)
+
     set_global_textmap(SentryPropagator())
 
 

sentry_sdk/integrations/opentelemetry/potel_span_processor.py

@@ -5,14 +5,14 @@
 from opentelemetry.sdk.trace import Span, ReadableSpan, SpanProcessor
 
 from sentry_sdk import capture_event
+from sentry_sdk.tracing import DEFAULT_SPAN_ORIGIN
 from sentry_sdk.integrations.opentelemetry.utils import (
     is_sentry_span,
-    convert_otel_timestamp,
+    convert_from_otel_timestamp,
     extract_span_data,
 )
 from sentry_sdk.integrations.opentelemetry.consts import (
     OTEL_SENTRY_CONTEXT,
-    SPAN_ORIGIN,
 )
 from sentry_sdk._types import TYPE_CHECKING
 
@@ -116,12 +116,12 @@ def _root_span_to_transaction_event(self, span):
         span_id = format_span_id(span.context.span_id)
         parent_span_id = format_span_id(span.parent.span_id) if span.parent else None
 
-        (op, description, status, _) = extract_span_data(span)
+        (op, description, status, _, origin) = extract_span_data(span)
 
         trace_context = {
             "trace_id": trace_id,
             "span_id": span_id,
-            "origin": SPAN_ORIGIN,
+            "origin": origin or DEFAULT_SPAN_ORIGIN,
             "op": op,
             "status": status,
         }  # type: dict[str, Any]
@@ -141,8 +141,8 @@ def _root_span_to_transaction_event(self, span):
             # TODO-neel-potel tx source based on integration
             "transaction_info": {"source": "custom"},
             "contexts": contexts,
-            "start_timestamp": convert_otel_timestamp(span.start_time),
-            "timestamp": convert_otel_timestamp(span.end_time),
+            "start_timestamp": convert_from_otel_timestamp(span.start_time),
+            "timestamp": convert_from_otel_timestamp(span.end_time),
         }  # type: Event
 
         return event
@@ -160,17 +160,17 @@ def _span_to_json(self, span):
         span_id = format_span_id(span.context.span_id)
         parent_span_id = format_span_id(span.parent.span_id) if span.parent else None
 
-        (op, description, status, _) = extract_span_data(span)
+        (op, description, status, _, origin) = extract_span_data(span)
 
         span_json = {
             "trace_id": trace_id,
             "span_id": span_id,
-            "origin": SPAN_ORIGIN,
             "op": op,
             "description": description,
             "status": status,
-            "start_timestamp": convert_otel_timestamp(span.start_time),
-            "timestamp": convert_otel_timestamp(span.end_time),
+            "start_timestamp": convert_from_otel_timestamp(span.start_time),
+            "timestamp": convert_from_otel_timestamp(span.end_time),
+            "origin": origin or DEFAULT_SPAN_ORIGIN,
         }  # type: dict[str, Any]
 
         if parent_span_id: