Merge branch 'major/3.0' into ivana/major/drop-experimental-options

Author: sentrivana

.github/workflows/flaky-test-detector.yml

@@ -108,7 +108,7 @@ jobs:
       # and the repo, and writes the issue body to flaky-issue-body.md.
       - name: Analyze logs and summarize flaky tests
         if: steps.collect.outputs.collected != '0'
-        uses: anthropics/claude-code-action@1f291e1cfe0f5fc21db2aef19af844591600ade7 # v1.0.206
+        uses: anthropics/claude-code-action@70fec183852c4f82f3f1969faed7dd60c5149ca7 # v1.0.207
         with:
           anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
           github_token: ${{ github.token }}

MIGRATION_GUIDE.md

@@ -24,6 +24,71 @@ 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
+
+- The standard library logging integration is not auto-enabled by default anymore. To continue using it, add it to the `integrations` list in your `sentry_sdk.init()`:
+
+  ```python
+  import sentry_sdk
+  from sentry_sdk.integrations.logging import LoggingIntegration
+
+  sentry_sdk.init(
+      integrations=[
+          LoggingIntegration(),
+      ]
+  )
+  ```
+
+- 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_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.
+
+  | Old name | New name | Old default | New default | Description |
+  | --- | --- | --- | --- | --- |
+  | `level` | `breadcrumb_level` | `INFO` | `INFO` | Captures logs of that level and higher as breadcrumbs. |
+  | `event_level` | `event_level` | `ERROR` | `None` | Captures logs of that level and higher as events. |
+  | `sentry_logs_level` | `level` | `INFO` | `INFO` | Captures logs of that level and higher as Sentry logs. |
+  | `capture_sentry_logs` | removed | `False` | n/a | Allows to opt out of instrumenting logs as Sentry logs. Use `level` (previously `sentry_logs_level`) to adjust what should be captured instead. |
+  | `ignore_logger` | `ignore_logger_for_events` | n/a | n/a | Loggers that match this name will not create breadcrumbs and events. |
+  | `unignore_logger` | `unignore_logger_for_events` | n/a | n/a | Loggers that match this name will create breadcrumbs and events again. |
+  | `ignore_logger_for_sentry_logs` | `ignore_logger` | n/a | n/a | Loggers that match this name will not create Sentry logs. |
+  | `unignore_logger_for_sentry_logs` | `unignore_logger` | n/a | n/a | Loggers that match this name will create Sentry logs again. |
+
+
+### Loguru
+
+- The Loguru logging integration is not auto-enabled by default anymore if you have Loguru installed. To continue using it, add it to the `integrations` list in your `sentry_sdk.init()`:
+
+  ```python
+  import sentry_sdk
+  from sentry_sdk.integrations.loguru import LoguruIntegration
+
+  sentry_sdk.init(
+      integrations=[
+          LoguruIntegration(),
+      ]
+  )
+  ```
+
+- 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.
+- When you enable the integration by adding `LoguruIntegration` 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.
+
+  | Old name | New name | Old default | New default | Description |
+  | --- | --- | --- | --- | --- |
+  | `level` | `breadcrumb_level` | `INFO` | `INFO` | Captures logs of that level and higher as breadcrumbs. |
+  | `event_level` | `event_level` | `ERROR` | `None` | Captures logs of that level and higher as events. |
+  | `sentry_logs_level` | `level` | `INFO` | `INFO` | Captures logs of that level and higher as Sentry logs. |
+  | `capture_sentry_logs` | removed | `False` | n/a | Allows to opt out of instrumenting logs as Sentry logs. Use `level` (previously `sentry_logs_level`) to adjust what should be captured instead. |
+
 
 ## Removed
 
@@ -51,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.
@@ -87,9 +138,19 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - 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

@@ -1286,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,