ref: Move consts, utils from integrations/opentelemetry/ (#4272)

Moving stuff out of `integrations/opentelemetry/` step by step since
there is no OpenTelemetry integration anymore -- it's part of the core
SDK. This moves
`sentry_sdk/integrations/opentelemetry/{utils,consts}.py` ->
`sentry_sdk/opentelemetry/{utils,consts}.py`.

There's quite some stuff moving around in this PR in order to remove
circular dependencies that have to do with `tracing.py`:
- `get_span_status_from_http_code` from `tracing.py` is now in
`tracing_utils.py`
- various constants from `tracing.py` are now in `consts.py`

Additionally, Sphinx was unhappy, so tweaked the way we type some things
in `api.py` and `_init_implementation.py`.

I'll possibly follow this up with creating a nice structure for the
tracing files, maybe a common `tracing` directory with `tracing.py`,
`tracing_utils.py` -> `utils.py`, and dedicated `consts.py`.

Ref #3853

Author: sentrivana

sentry_sdk/_init_implementation.py

@@ -1,13 +1,12 @@
 from typing import TYPE_CHECKING
 
 import sentry_sdk
+from sentry_sdk.consts import ClientConstructor
 from sentry_sdk.integrations.opentelemetry.scope import setup_scope_context_management
 
 if TYPE_CHECKING:
     from typing import Any, Optional
 
-    import sentry_sdk.consts
-
 
 def _check_python_deprecations():
     # type: () -> None
@@ -36,7 +35,7 @@ def _init(*args, **kwargs):
     # Use `ClientConstructor` to define the argument types of `init` and
     # `ContextManager[Any]` to tell static analyzers about the return type.
 
-    class init(sentry_sdk.consts.ClientConstructor):  # noqa: N801
+    class init(ClientConstructor):  # noqa: N801
         pass
 
 else:

sentry_sdk/api.py

@@ -30,17 +30,7 @@
     from typing import Union
     from typing import Generator
 
-    from sentry_sdk.client import BaseClient
-    from sentry_sdk._types import (
-        Event,
-        Hint,
-        Breadcrumb,
-        BreadcrumbHint,
-        ExcInfo,
-        MeasurementUnit,
-        LogLevelStr,
-    )
-    from sentry_sdk.tracing import Span
+    import sentry_sdk
 
     T = TypeVar("T")
     F = TypeVar("F", bound=Callable[..., Any])
@@ -102,7 +92,7 @@ def clientmethod(f):
 
 @scopemethod
 def get_client():
-    # type: () -> BaseClient
+    # type: () -> sentry_sdk.client.BaseClient
     return Scope.get_client()
 
 
@@ -150,8 +140,8 @@ def last_event_id():
 
 @scopemethod
 def capture_event(
-    event,  # type: Event
-    hint=None,  # type: Optional[Hint]
+    event,  # type: sentry_sdk._types.Event
+    hint=None,  # type: Optional[sentry_sdk._types.Hint]
     scope=None,  # type: Optional[Any]
     **scope_kwargs,  # type: Any
 ):
@@ -162,7 +152,7 @@ def capture_event(
 @scopemethod
 def capture_message(
     message,  # type: str
-    level=None,  # type: Optional[LogLevelStr]
+    level=None,  # type: Optional[sentry_sdk._types.LogLevelStr]
     scope=None,  # type: Optional[Any]
     **scope_kwargs,  # type: Any
 ):
@@ -174,7 +164,7 @@ def capture_message(
 
 @scopemethod
 def capture_exception(
-    error=None,  # type: Optional[Union[BaseException, ExcInfo]]
+    error=None,  # type: Optional[Union[BaseException, sentry_sdk._types.ExcInfo]]
     scope=None,  # type: Optional[Any]
     **scope_kwargs,  # type: Any
 ):
@@ -184,8 +174,8 @@ def capture_exception(
 
 @scopemethod
 def add_breadcrumb(
-    crumb=None,  # type: Optional[Breadcrumb]
-    hint=None,  # type: Optional[BreadcrumbHint]
+    crumb=None,  # type: Optional[sentry_sdk._types.Breadcrumb]
+    hint=None,  # type: Optional[sentry_sdk._types.BreadcrumbHint]
     **kwargs,  # type: Any
 ):
     # type: (...) -> None
@@ -224,7 +214,7 @@ def set_user(value):
 
 @scopemethod
 def set_level(value):
-    # type: (LogLevelStr) -> None
+    # type: (sentry_sdk._types.LogLevelStr) -> None
     return get_isolation_scope().set_level(value)
 
 
@@ -238,7 +228,7 @@ def flush(
 
 
 def start_span(**kwargs):
-    # type: (Any) -> Span
+    # type: (Any) -> sentry_sdk.tracing.Span
     """
     Start and return a span.
 
@@ -255,10 +245,10 @@ def start_span(**kwargs):
 
 
 def start_transaction(
-    transaction=None,  # type: Optional[Span]
+    transaction=None,  # type: Optional[sentry_sdk.tracing.Span]
     **kwargs,  # type: Any
 ):
-    # type: (...) -> Span
+    # type: (...) -> sentry_sdk.tracing.Span
     """
     .. deprecated:: 3.0.0
         This function is deprecated and will be removed in a future release.
@@ -298,14 +288,14 @@ def start_transaction(
 
 
 def set_measurement(name, value, unit=""):
-    # type: (str, float, MeasurementUnit) -> None
+    # type: (str, float, sentry_sdk._types.MeasurementUnit) -> None
     transaction = get_current_scope().root_span
     if transaction is not None:
         transaction.set_measurement(name, value, unit)
 
 
 def get_current_span(scope=None):
-    # type: (Optional[Scope]) -> Optional[Span]
+    # type: (Optional[Scope]) -> Optional[sentry_sdk.tracing.Span]
     """
     Returns the currently active span if there is one running, otherwise `None`
     """

sentry_sdk/consts.py

@@ -478,6 +478,46 @@ class OP:
     SOCKET_DNS = "socket.dns"
 
 
+BAGGAGE_HEADER_NAME = "baggage"
+SENTRY_TRACE_HEADER_NAME = "sentry-trace"
+
+DEFAULT_SPAN_ORIGIN = "manual"
+DEFAULT_SPAN_NAME = "<unlabeled span>"
+
+
+# Transaction source
+# see https://develop.sentry.dev/sdk/event-payloads/transaction/#transaction-annotations
+class TransactionSource(str, Enum):
+    COMPONENT = "component"
+    CUSTOM = "custom"
+    ROUTE = "route"
+    TASK = "task"
+    URL = "url"
+    VIEW = "view"
+
+    def __str__(self):
+        # type: () -> str
+        return self.value
+
+
+# These are typically high cardinality and the server hates them
+LOW_QUALITY_TRANSACTION_SOURCES = [
+    TransactionSource.URL,
+]
+
+SOURCE_FOR_STYLE = {
+    "endpoint": TransactionSource.COMPONENT,
+    "function_name": TransactionSource.COMPONENT,
+    "handler_name": TransactionSource.COMPONENT,
+    "method_and_path_pattern": TransactionSource.ROUTE,
+    "path": TransactionSource.URL,
+    "route_name": TransactionSource.COMPONENT,
+    "route_pattern": TransactionSource.ROUTE,
+    "uri_template": TransactionSource.ROUTE,
+    "url": TransactionSource.ROUTE,
+}
+
+
 # This type exists to trick mypy and PyCharm into thinking `init` and `Client`
 # take these arguments (even though they take opaque **kwargs)
 class ClientConstructor:

sentry_sdk/integrations/aiohttp.py

@@ -3,7 +3,14 @@
 from functools import wraps
 
 import sentry_sdk
-from sentry_sdk.consts import OP, SPANSTATUS, SPANDATA
+from sentry_sdk.consts import (
+    OP,
+    SPANSTATUS,
+    SPANDATA,
+    BAGGAGE_HEADER_NAME,
+    SOURCE_FOR_STYLE,
+    TransactionSource,
+)
 from sentry_sdk.integrations import (
     _DEFAULT_FAILED_REQUEST_STATUS_CODES,
     _check_minimum_version,
@@ -17,11 +24,6 @@
     _request_headers_to_span_attributes,
     request_body_within_bounds,
 )
-from sentry_sdk.tracing import (
-    BAGGAGE_HEADER_NAME,
-    SOURCE_FOR_STYLE,
-    TransactionSource,
-)
 from sentry_sdk.tracing_utils import should_propagate_trace
 from sentry_sdk.utils import (
     capture_internal_exceptions,

sentry_sdk/integrations/asgi.py

@@ -10,7 +10,7 @@
 from functools import partial
 
 import sentry_sdk
-from sentry_sdk.consts import OP
+from sentry_sdk.consts import OP, SOURCE_FOR_STYLE, TransactionSource
 
 from sentry_sdk.integrations._asgi_common import (
     _get_headers,
@@ -23,10 +23,6 @@
     _request_headers_to_span_attributes,
 )
 from sentry_sdk.sessions import track_session
-from sentry_sdk.tracing import (
-    SOURCE_FOR_STYLE,
-    TransactionSource,
-)
 from sentry_sdk.utils import (
     ContextVar,
     capture_internal_exceptions,

sentry_sdk/integrations/bottle.py

@@ -1,7 +1,7 @@
 import functools
 
 import sentry_sdk
-from sentry_sdk.tracing import SOURCE_FOR_STYLE
+from sentry_sdk.consts import SOURCE_FOR_STYLE
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,

sentry_sdk/integrations/celery/__init__.py

@@ -4,7 +4,7 @@
 
 import sentry_sdk
 from sentry_sdk import isolation_scope
-from sentry_sdk.consts import OP, SPANSTATUS, SPANDATA
+from sentry_sdk.consts import OP, SPANSTATUS, SPANDATA, BAGGAGE_HEADER_NAME
 from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
 from sentry_sdk.integrations.celery.beat import (
     _patch_beat_apply_entry,
@@ -13,7 +13,7 @@
 )
 from sentry_sdk.integrations.celery.utils import _now_seconds_since_epoch
 from sentry_sdk.integrations.logging import ignore_logger
-from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, TransactionSource
+from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.tracing_utils import Baggage
 from sentry_sdk.utils import (
     capture_internal_exceptions,

sentry_sdk/integrations/django/__init__.py

@@ -6,10 +6,9 @@
 from importlib import import_module
 
 import sentry_sdk
-from sentry_sdk.consts import OP, SPANDATA
+from sentry_sdk.consts import OP, SPANDATA, SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.scope import add_global_event_processor, should_send_default_pii
 from sentry_sdk.serializer import add_global_repr_processor
-from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.tracing_utils import add_query_source, record_sql_queries
 from sentry_sdk.utils import (
     AnnotatedValue,

sentry_sdk/integrations/falcon.py

@@ -1,8 +1,8 @@
 import sentry_sdk
+from sentry_sdk.consts import SOURCE_FOR_STYLE
 from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
 from sentry_sdk.integrations._wsgi_common import RequestExtractor
 from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware
-from sentry_sdk.tracing import SOURCE_FOR_STYLE
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,

sentry_sdk/integrations/fastapi.py

@@ -3,9 +3,9 @@
 from functools import wraps
 
 import sentry_sdk
+from sentry_sdk.consts import SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.integrations import DidNotEnable
 from sentry_sdk.scope import should_send_default_pii
-from sentry_sdk.tracing import SOURCE_FOR_STYLE, TransactionSource
 from sentry_sdk.utils import (
     transaction_from_function,
     logger,