Merge branch 'major/3.0' into ivana/major/remove-transactions-from-wsgi

Author: sentrivana

MIGRATION_GUIDE.md

@@ -24,6 +24,8 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - The UnraisableHookIntegration is now enabled by default.
 - We now don't suppress chained exceptions in the ASGI and asyncio integrations by default. The related `suppress_asgi_chained_exceptions` experimental option was removed.
 - In the AWS Lambda and GCP integrations, the message of the warning the SDK optionally emits if a function is about to time out has changed.
+- We changed the way we emit warnings. Deprecations will from now on be always emitted using `warnings.warn()`, while all other warnings will be emitted using `logger.warning()`.
+- `sentry_sdk.init()` can no longer be used as a context manager.
 
 ### Logging
 
@@ -43,7 +45,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - The `level` integration option is now called `breadcrumb_level`.
 - The `sentry_logs_level` integration option is now called `level`.
 - The `capture_sentry_logs` option was removed. Use `level=None` to disable log capture.
-- The `ignore_logger` helper was renamed to `ignore_logger_for_breadcrumbs_and_events`.
+- The `ignore_logger` helper was renamed to `ignore_logger_for_events`.
 - The `ignore_logger_for_sentry_logs` helper was renamed to `ignore_logger`.
 - `SentryHandler` was removed. Use `EventHandler` instead.
 - When you enable the integration by adding `LoggingIntegration` to your `sentry_sdk.init()`, it'll start capturing Sentry logs and breadcrumbs. Creating events from logs can be enabled by providing additional integration options.
@@ -114,21 +116,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - Removed the RedisIntegration `max_data_size` option.
 - Removed the possibility to supply a specific client to the LaunchDarklyIntegration.
 - The `enable_tracing` option was removed. Use `traces_sample_rate=1.0` instead.
-- The `enable_logs` option was removed. Using Sentry's logging API now works without requiring setting `enable_logs=True`. Automatic capture of logs emitted by the `logging` standard library module or Loguru can be turned on by providing the `capture_sentry_logs=True` option to either `LoggingIntegration` or `LoguruIntegration`:
-
-  ```python
-  import sentry_sdk
-  from sentry_sdk.integrations.logging import LoggingIntegration
-  from sentry_sdk.integrations.loguru import LoguruIntegration
-
-  sentry_sdk.init(
-      integrations=[
-          LoggingIntegration(capture_sentry_logs=True),
-          LoguruIntegration(capture_sentry_logs=True),
-      ]
-  )
-  ```
-
+- The `enable_logs` option was removed. Using Sentry's logging API now works without requiring setting `enable_logs=True`.
 - The `enable_metrics` option was removed.
 - The deprecated `@ai_track` decorator was removed.
 - The deprecated `push_scope` and `configure_scope` APIs have been removed. Use `with new_scope():` to push a new scope and `scope = get_current_scope()` to retrieve the current scope instead.
@@ -145,9 +133,24 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - The deprecated `propagate_traces` option has been removed. Use `trace_propagation_targets` instead, which gives you more power over trace propagation. Note that only the top-level `init` option was removed; the `propagate_traces` option of the Celery integration remains available.
 - Removed Spotlight integration for Django. See [Spotlight 2.0](https://github.com/getsentry/spotlight/issues/891) for more context.
 - The deprecated parameter `propagate_hub` in `ThreadingIntegration()` was removed.
+- The experimental `max_spans` option was removed.
+- The experimental `before_send_log` option was removed. Use the top-level `before_send_log` instead.
+- The experimental `before_send_metric` option was removed. Use the top-level `before_send_metric` instead.
+- The experimental `ignore_spans` option was removed. Use the top-level `ignore_spans` instead.
+- The experimental `before_send_span` option was removed. Use the top-level `before_send_span` instead.
+- `configure_debug_hub` was removed.
+- The `max_spans` option of the `LangchainIntegration` was removed.
+- `Baggage.from_options` was removed.
+- `Transport.capture_event` was removed. Use `Transport.capture_envelope` instead.
+- Function transports were removed.
+- The `Scope.trace_propagation_meta` function no longer accepts a `span` as argument.
+- Direct assignment to `Scope.level` was removed. Use `Scope.set_level` instead.
+- Direct assignment to `Scope.user` was removed. Use `Scope.set_user` instead.
+- `Scope.iter_headers` was removed.
 - The SDK won't set any tags on its own anymore.
 - The `update_current_span` API was removed.
 
+
 ## Deprecated
 
 

sentry_sdk/_compat.py

@@ -61,30 +61,26 @@ def enabled(option: str) -> bool:
     lazy_mode = enabled("lazy-apps") or enabled("lazy")
 
     if lazy_mode and not threads_enabled:
-        from warnings import warn
-
-        warn(
-            Warning(
-                "IMPORTANT: "
-                "We detected the use of uWSGI without thread support. "
-                "This might lead to unexpected issues. "
-                'Please run uWSGI with "--enable-threads" for full support.'
-            )
+        from sentry_sdk.utils import logger
+
+        logger.warning(
+            "IMPORTANT: "
+            "We detected the use of uWSGI without thread support. "
+            "This might lead to unexpected issues. "
+            'Please run uWSGI with "--enable-threads" for full support.'
         )
 
         return False
 
     elif not lazy_mode and (not threads_enabled or not fork_hooks_on):
-        from warnings import warn
-
-        warn(
-            Warning(
-                "IMPORTANT: "
-                "We detected the use of uWSGI in preforking mode without "
-                "thread support. This might lead to crashing workers. "
-                'Please run uWSGI with both "--enable-threads" and '
-                '"--py-call-uwsgi-fork-hooks" for full support.'
-            )
+        from sentry_sdk.utils import logger
+
+        logger.warning(
+            "IMPORTANT: "
+            "We detected the use of uWSGI in preforking mode without "
+            "thread support. This might lead to crashing workers. "
+            'Please run uWSGI with both "--enable-threads" and '
+            '"--py-call-uwsgi-fork-hooks" for full support.'
         )
 
         return False

sentry_sdk/_init_implementation.py

@@ -1,48 +1,15 @@
 import re
-import warnings
 from typing import TYPE_CHECKING
 
 import sentry_sdk
 from sentry_sdk.utils import logger, parse_version
 
 if TYPE_CHECKING:
-    from typing import Any, ContextManager, Optional
+    from typing import Any, Optional
 
     import sentry_sdk.consts
 
 
-class _InitGuard:
-    _CONTEXT_MANAGER_DEPRECATION_WARNING_MESSAGE = (
-        "Using the return value of sentry_sdk.init as a context manager "
-        "and manually calling the __enter__ and __exit__ methods on the "
-        "return value are deprecated. We are no longer maintaining this "
-        "functionality, and we will remove it in the next major release."
-    )
-
-    def __init__(self, client: "sentry_sdk.Client") -> None:
-        self._client = client
-
-    def __enter__(self) -> "_InitGuard":
-        warnings.warn(
-            self._CONTEXT_MANAGER_DEPRECATION_WARNING_MESSAGE,
-            stacklevel=2,
-            category=DeprecationWarning,
-        )
-
-        return self
-
-    def __exit__(self, exc_type: "Any", exc_value: "Any", tb: "Any") -> None:
-        warnings.warn(
-            self._CONTEXT_MANAGER_DEPRECATION_WARNING_MESSAGE,
-            stacklevel=2,
-            category=DeprecationWarning,
-        )
-
-        c = self._client
-        if c is not None:
-            c.close()
-
-
 def _check_version_deprecations() -> None:
     try:
         import gevent
@@ -71,26 +38,23 @@ def _check_version_deprecations() -> None:
         pass
 
 
-def _init(*args: "Optional[str]", **kwargs: "Any") -> "ContextManager[Any]":
+def _init(*args: "Optional[str]", **kwargs: "Any") -> None:
     """Initializes the SDK and optionally integrations.
 
     This takes the same arguments as the client constructor.
     """
     client = sentry_sdk.Client(*args, **kwargs)
     sentry_sdk.get_global_scope().set_client(client)
     _check_version_deprecations()
-    rv = _InitGuard(client)
-    return rv
 
 
 if TYPE_CHECKING:
     # Make mypy, PyCharm and other static analyzers think `init` is a type to
     # have nicer autocompletion for params.
     #
-    # Use `ClientConstructor` to define the argument types of `init` and
-    # `ContextManager[Any]` to tell static analyzers about the return type.
+    # Use `ClientConstructor` to define the argument types of `init`.
 
-    class init(sentry_sdk.consts.ClientConstructor, _InitGuard):  # noqa: N801
+    class init(sentry_sdk.consts.ClientConstructor):  # noqa: N801
         pass
 
 else:

sentry_sdk/_types.py

@@ -183,7 +183,7 @@ class DataCollectionUserOptions(TypedDict, total=False):
         gen_ai: "GenAICollectionUserOptions"
         database_query_data: bool
         queues: bool
-        stack_frame_variables: bool
+        stack_frame_variables: "Union[bool, KeyValueCollectionBehaviour]"
         frame_context_lines: int
 
     class DataCollection(TypedDict):
@@ -197,7 +197,7 @@ class DataCollection(TypedDict):
         gen_ai: "GenAICollectionBehaviour"
         database_query_data: bool
         queues: bool
-        stack_frame_variables: bool
+        stack_frame_variables: "Union[bool, KeyValueCollectionBehaviour]"
         frame_context_lines: int
 
     # "critical" is an alias of "fatal" recognized by Relay

sentry_sdk/client.py

@@ -5,7 +5,6 @@
 import socket
 import sys
 import uuid
-import warnings
 from collections.abc import Iterable, Mapping
 from contextvars import ContextVar
 from datetime import datetime, timezone
@@ -348,9 +347,8 @@ def _get_options(*args: "Optional[str]", **kwargs: "Any") -> "Dict[str, Any]":
             else rv["send_default_pii"]
         )
     elif has_data_collection_enabled(rv) and rv["event_scrubber"]:
-        warnings.warn(
+        logger.warning(
             "Event scrubbers are not enabled when data collection configuration is provided. Ignoring event_scrubber...",
-            stacklevel=2,
         )
         rv["event_scrubber"] = None
 
@@ -366,21 +364,18 @@ def _get_options(*args: "Optional[str]", **kwargs: "Any") -> "Dict[str, Any]":
         )
 
     if rv["trace_ignore_status_codes"] and has_span_streaming_enabled(rv):
-        warnings.warn(
+        logger.warning(
             "The `trace_ignore_status_codes` parameter is ignored in span streaming mode.",
-            stacklevel=2,
         )
 
     if rv["ignore_spans"] and not has_span_streaming_enabled(rv):
-        warnings.warn(
+        logger.warning(
             "The `ignore_spans` parameter only works when `trace_lifecycle` is set to `stream`.",
-            stacklevel=2,
         )
 
     if rv["before_send_span"] and not has_span_streaming_enabled(rv):
-        warnings.warn(
+        logger.warning(
             "The `before_send_span` parameter only works when `trace_lifecycle` is set to `stream`.",
-            stacklevel=2,
         )
 
     return rv
@@ -1334,9 +1329,8 @@ def close(
         """
         if self.transport is not None:
             if self._has_async_transport():
-                warnings.warn(
+                logger.warning(
                     "close() used with AsyncHttpTransport. Use close_async() instead.",
-                    stacklevel=2,
                 )
                 self._flush_components()
             else:
@@ -1381,9 +1375,8 @@ def flush(
         """
         if self.transport is not None:
             if self._has_async_transport():
-                warnings.warn(
+                logger.warning(
                     "flush() used with AsyncHttpTransport. Use flush_async() instead.",
-                    stacklevel=2,
                 )
                 return
             if timeout is None:

sentry_sdk/consts.py

@@ -64,7 +64,6 @@ class CompressionAlgo(Enum):
     Experiments = TypedDict(
         "Experiments",
         {
-            "max_spans": Optional[int],
             "max_flags": Optional[int],
             "record_sql_params": Optional[bool],
             "continuous_profiling_auto_start": Optional[bool],
@@ -74,13 +73,7 @@ class CompressionAlgo(Enum):
             "transport_num_pools": Optional[int],
             "transport_http2": Optional[bool],
             "transport_async": Optional[bool],
-            "before_send_log": Optional[Callable[[Log, Hint], Optional[Log]]],
-            "before_send_metric": Optional[Callable[[Metric, Hint], Optional[Metric]]],
             "trace_lifecycle": Optional[Literal["static", "stream"]],
-            "ignore_spans": Optional[IgnoreSpansConfig],
-            "before_send_span": Optional[
-                Callable[[SpanJSON, Hint], Optional[SpanJSON]]
-            ],
             "data_collection": Optional[DataCollectionUserOptions],
         },
         total=False,
@@ -1293,7 +1286,7 @@ def __init__(
         in_app_exclude: "List[str]" = [],  # noqa: B006
         default_integrations: bool = True,
         dist: "Optional[str]" = None,
-        transport: "Optional[Union[sentry_sdk.transport.Transport, Type[sentry_sdk.transport.Transport], Callable[[Event], None]]]" = None,
+        transport: "Optional[Union[sentry_sdk.transport.Transport, Type[sentry_sdk.transport.Transport], None]]" = None,
         transport_queue_size: int = DEFAULT_QUEUE_SIZE,
         sample_rate: float = 1.0,
         send_default_pii: "Optional[bool]" = None,

sentry_sdk/data_collection.py

@@ -22,15 +22,12 @@
   ``DeprecationWarning`` is emitted for ``send_default_pii``.
 """
 
-import warnings
-from typing import TYPE_CHECKING, List, Mapping, Optional, Union, cast
+from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Optional, Union, cast
 from urllib.parse import parse_qs, urlencode
 
 from sentry_sdk._types import SENSITIVE_DATA_SUBSTITUTE
 
 if TYPE_CHECKING:
-    from typing import Any, Dict
-
     from sentry_sdk._types import (
         DataCollection,
         GenAICollectionBehaviour,
@@ -190,29 +187,31 @@ def _map_from_send_default_pii(
 
 def _resolve_explicit(
     d: "dict[str, Any]",
-    include_local_variables: bool,
-    include_source_context: bool,
 ) -> "DataCollection":
     """
     Build a fully-resolved ``DataCollection`` from a user-supplied
     ``data_collection`` dict, filling in spec defaults for any omitted or
-    partially-specified field. Frame fields fall back to the legacy
-    ``include_local_variables`` / ``include_source_context`` options when unset.
+    partially-specified field.
     """
-    # frame_context_lines accepts an integer or a boolean fallback (spec: True
-    # -> platform default of 5, False -> 0). bool is a subclass of int, so
-    # coerce explicitly before treating it as a line count.
     frame_context_lines = d.get("frame_context_lines")
     if frame_context_lines is None:
-        frame_context_lines = (
-            _DEFAULT_FRAME_CONTEXT_LINES if include_source_context else 0
-        )
+        frame_context_lines = _DEFAULT_FRAME_CONTEXT_LINES
     elif isinstance(frame_context_lines, bool):
         frame_context_lines = _DEFAULT_FRAME_CONTEXT_LINES if frame_context_lines else 0
+    else:
+        if not isinstance(frame_context_lines, int) or frame_context_lines < 0:
+            raise ValueError(
+                "Invalid `frame_context_lines` value: Must be 0 or greater."
+            )
+
+    raw_stack_frame_variables = d.get("stack_frame_variables", True)
+    stack_frame_variables: "Union[bool, KeyValueCollectionBehaviour]"
 
-    stack_frame_variables = d.get("stack_frame_variables")
-    if stack_frame_variables is None:
-        stack_frame_variables = include_local_variables
+    stack_frame_variables = (
+        _kvcb_from_value(raw_stack_frame_variables)
+        if isinstance(raw_stack_frame_variables, dict)
+        else bool(raw_stack_frame_variables)
+    )
 
     # http_bodies: omitted means "all valid types"; [] is the explicit opt-out.
     http_bodies = d.get("http_bodies")
@@ -293,6 +292,8 @@ def _resolve_data_collection(options: "Dict[str, Any]") -> "DataCollection":
 
     ``data_collection`` must be a plain ``dict``.
     """
+    from sentry_sdk.utils import deprecation_warning
+
     user_dc = options.get("_experiments", {}).get("data_collection")
     send_default_pii = options.get("send_default_pii")
 
@@ -315,16 +316,12 @@ def _resolve_data_collection(options: "Dict[str, Any]") -> "DataCollection":
                 )
             )
         if send_default_pii is not None:
-            warnings.warn(
+            deprecation_warning(
                 "`send_default_pii` is deprecated and ignored when "
                 "`data_collection` is set.",
-                DeprecationWarning,
-                stacklevel=2,
             )
         return _resolve_explicit(
             user_dc,
-            include_local_variables,
-            include_source_context,
         )
 
     return _map_from_send_default_pii(