merge master

Author: alexander-alderman-webb

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 2.69.1
+
+### New Features ✨
+
+- (django) Add `http.route` attribute by @alexander-alderman-webb in [#7428](https://github.com/getsentry/sentry-python/pull/7428)
+
+### Bug Fixes 🐛
+
+- (aiohttp) Preserve SigV4-signed propagation headers by @Robinbinu in [#7427](https://github.com/getsentry/sentry-python/pull/7427)
+
+### Internal Changes 🔧
+
+#### Mcp
+
+- Parametrize tests on the streaming trace lifecycle by @alexander-alderman-webb in [#7424](https://github.com/getsentry/sentry-python/pull/7424)
+- Remove vacuous tests by @alexander-alderman-webb in [#7420](https://github.com/getsentry/sentry-python/pull/7420)
+
+#### Other
+
+- (cohere) Parametrize tests on the streaming trace lifecycle by @alexander-alderman-webb in [#7419](https://github.com/getsentry/sentry-python/pull/7419)
+- (openai-agents) Parametrize tests on `stream_gen_ai_spans` and the streaming trace lifecycle by @alexander-alderman-webb in [#7405](https://github.com/getsentry/sentry-python/pull/7405)
+
 ## 2.69.0
 
 ### New Features ✨

docs/conf.py

@@ -31,7 +31,7 @@
 copyright = "2019-{}, Sentry Team and Contributors".format(datetime.now().year)
 author = "Sentry Team and Contributors"
 
-release = "2.69.0"
+release = "2.69.1"
 version = ".".join(release.split(".")[:2])  # The short X.Y version.
 
 

sentry_sdk/client.py

@@ -36,7 +36,8 @@
 from sentry_sdk.serializer import serialize
 from sentry_sdk.sessions import SessionFlusher
 from sentry_sdk.traces import SpanStatus, StreamedSpan
-from sentry_sdk.tracing import trace
+from sentry_sdk.traces import trace as streaming_trace
+from sentry_sdk.tracing import trace as legacy_trace
 from sentry_sdk.tracing_utils import has_span_streaming_enabled
 from sentry_sdk.transport import (
     AsyncHttpTransport,
@@ -509,8 +510,14 @@ def _setup_instrumentation(
         self, functions_to_trace: "Sequence[Dict[str, str]]"
     ) -> None:
         """
-        Instruments the functions given in the list `functions_to_trace` with the `@sentry_sdk.tracing.trace` decorator.
+        Instruments the functions given in the list `functions_to_trace` with a trace decorator.
         """
+        trace = (
+            streaming_trace
+            if has_span_streaming_enabled(self.options)
+            else legacy_trace
+        )
+
         for function in functions_to_trace:
             class_name = None
             function_qualname = function["qualified_name"]

sentry_sdk/consts.py

@@ -7,6 +7,8 @@
 DEFAULT_MAX_STACK_FRAMES = 100
 DEFAULT_ADD_FULL_STACK = False
 
+_SENTRY_HEADER_NAMES = frozenset(("baggage", "sentry-trace"))
+
 
 # Also needs to be at the top to prevent circular import
 class EndpointType(Enum):
@@ -1802,4 +1804,4 @@ def _get_default_options() -> "dict[str, Any]":
 del _get_default_options
 
 
-VERSION = "2.69.0"
+VERSION = "2.69.1"

sentry_sdk/integrations/aiohttp.py

@@ -3,7 +3,7 @@
 from functools import wraps
 
 import sentry_sdk
-from sentry_sdk.consts import OP, SPANDATA
+from sentry_sdk.consts import _SENTRY_HEADER_NAMES, OP, SPANDATA
 from sentry_sdk.data_collection import (
     _apply_data_collection_filtering_to_query_string,
 )
@@ -27,6 +27,7 @@
 )
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,
+    SENTRY_TRACE_HEADER_NAME,
     SOURCE_FOR_STYLE,
 )
 from sentry_sdk.tracing_utils import (
@@ -37,6 +38,8 @@
 from sentry_sdk.utils import (
     SENSITIVE_DATA_SUBSTITUTE,
     AnnotatedValue,
+    _get_aws_sigv4_signed_headers_from_authorization_header,
+    _get_aws_sigv4_signed_headers_from_url_query_string,
     _register_control_flow_exception,
     capture_internal_exceptions,
     ensure_integration_enabled,
@@ -389,12 +392,50 @@ async def on_request_start(
             span = sentry_sdk.traces.start_span(name=span_name, attributes=attributes)
 
         if should_propagate_trace(client, str(params.url)):
+            # existing `sentry-trace`: skip so it is not duplicated.
+            headers_to_skip: "set[str]" = set()
+            if SENTRY_TRACE_HEADER_NAME in params.headers:
+                headers_to_skip.add(SENTRY_TRACE_HEADER_NAME)
+
+            with capture_internal_exceptions():
+                authorization = params.headers.get("Authorization")
+                if authorization:
+                    if isinstance(authorization, bytes):
+                        authorization = authorization.decode("latin-1")
+                    # `SignedHeaders` lists fields covered by SigV4.
+                    signed_headers = (
+                        _get_aws_sigv4_signed_headers_from_authorization_header(
+                            authorization
+                        )
+                    )
+                    # skip signed `sentry-trace` and `baggage`.
+                    headers_to_skip.update(
+                        _SENTRY_HEADER_NAMES.intersection(signed_headers)
+                    )
+
+                # presigned URLs list signed names in the query string.
+                query_signed_headers = (
+                    _get_aws_sigv4_signed_headers_from_url_query_string(str(params.url))
+                )
+                headers_to_skip.update(
+                    _SENTRY_HEADER_NAMES.intersection(query_signed_headers)
+                )
+
             for (
                 key,
                 value,
             ) in sentry_sdk.get_current_scope().iter_trace_propagation_headers(
                 span=span
             ):
+                # skip signed headers and an existing `sentry-trace`.
+                if key.lower() in headers_to_skip:
+                    logger.debug(
+                        "[Tracing] Not adding `{key}` header to outgoing request "
+                        "to {url}: it already exists or is covered by the AWS "
+                        "SigV4 signature.".format(key=key, url=params.url)
+                    )
+                    continue
+
                 logger.debug(
                     "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
                         key=key, value=value, url=params.url

sentry_sdk/integrations/aws_lambda.py

@@ -43,6 +43,9 @@
 
 
 def _get_user_from_event(aws_event: "dict[str, Any]") -> "dict[str, Any]":
+    if not isinstance(aws_event, dict):
+        return {}
+
     identity = aws_event.get("requestContext", {}).get("identity")
     if identity is None:
         return {}

sentry_sdk/integrations/clickhouse_driver.py

@@ -161,7 +161,7 @@ def _inner_end(*args: "P.args", **kwargs: "P.kwargs") -> "T":
             sentry_sdk.get_isolation_scope().add_breadcrumb(
                 message=query,
                 category="query",
-                data={"db.result": res, **breadcrumb_data},
+                data=breadcrumb_data,
             )
 
         span = getattr(instance.connection, "_sentry_span", None)

sentry_sdk/integrations/django/__init__.py

@@ -389,21 +389,19 @@ def _patch_django_asgi_handler() -> None:
 
 
 def _set_transaction_name_and_source(
-    scope: "sentry_sdk.Scope", transaction_style: str, request: "WSGIRequest"
+    scope: "sentry_sdk.Scope",
+    transaction_style: str,
+    request: "WSGIRequest",
+    route_path: "Optional[str]",
 ) -> None:
     try:
         transaction_name = None
         if transaction_style == "function_name":
             fn = resolve(request.path).func
             transaction_name = transaction_from_function(getattr(fn, "view_class", fn))
 
-        elif transaction_style == "url":
-            if hasattr(request, "urlconf"):
-                transaction_name = LEGACY_RESOLVER.resolve(
-                    request.path_info, urlconf=request.urlconf
-                )
-            else:
-                transaction_name = LEGACY_RESOLVER.resolve(request.path_info)
+        elif transaction_style == "url" and route_path is not None:
+            transaction_name = route_path
 
         if transaction_name is None:
             transaction_name = request.path_info
@@ -415,6 +413,11 @@ def _set_transaction_name_and_source(
             transaction_name,
             source=source,
         )
+
+        if transaction_style == "url" and route_path is not None:
+            server_span = scope._server_segment_span
+            if server_span is not None:
+                server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)
     except Resolver404:
         urlconf = import_module(settings.ROOT_URLCONF)
         # This exception only gets thrown when transaction_style is `function_name`
@@ -439,8 +442,29 @@ def _before_get_response(request: "WSGIRequest") -> None:
     _patch_drf()
 
     scope = sentry_sdk.get_current_scope()
+
+    route_path = None
+    if hasattr(request, "urlconf"):
+        try:
+            route_path = LEGACY_RESOLVER.resolve(
+                request.path_info, urlconf=request.urlconf
+            )
+        except Exception:
+            pass
+    else:
+        try:
+            route_path = LEGACY_RESOLVER.resolve(request.path_info)
+        except Exception:
+            pass
+
+    server_span = sentry_sdk.get_current_scope()._server_segment_span
+    if server_span is not None and route_path is not None:
+        server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)
+
     # Rely on WSGI middleware to start a trace
-    _set_transaction_name_and_source(scope, integration.transaction_style, request)
+    _set_transaction_name_and_source(
+        scope, integration.transaction_style, request, route_path=route_path
+    )
 
     scope.add_event_processor(
         _make_wsgi_request_event_processor(weakref.ref(request), integration)
@@ -458,7 +482,27 @@ def _attempt_resolve_again(
     if not hasattr(request, "urlconf"):
         return
 
-    _set_transaction_name_and_source(scope, transaction_style, request)
+    route_path = None
+    if hasattr(request, "urlconf"):
+        try:
+            route_path = LEGACY_RESOLVER.resolve(
+                request.path_info, urlconf=request.urlconf
+            )
+        except Exception:
+            pass
+    else:
+        try:
+            route_path = LEGACY_RESOLVER.resolve(request.path_info)
+        except Exception:
+            pass
+
+    server_span = sentry_sdk.get_current_scope()._server_segment_span
+    if server_span is not None and route_path is not None:
+        server_span.set_attribute(SPANDATA.HTTP_ROUTE, route_path)
+
+    _set_transaction_name_and_source(
+        scope, transaction_style, request, route_path=route_path
+    )
 
 
 def _get_user_from_request_and_set_on_scope(request: "WSGIRequest") -> None:

sentry_sdk/integrations/logging.py

@@ -399,14 +399,14 @@ def _can_record(self, record: "LogRecord") -> bool:
 
     def emit(self, record: "LogRecord") -> "Any":
         with capture_internal_exceptions():
-            self.format(record)
             if not self._can_record(record):
                 return
 
             client = sentry_sdk.get_client()
             if not client.is_active():
                 return
 
+            self.format(record)
             self._capture_log_from_record(client, record)
 
     def _capture_log_from_record(

sentry_sdk/integrations/stdlib.py

@@ -6,11 +6,11 @@
 from typing import TYPE_CHECKING
 
 import sentry_sdk
-from sentry_sdk.consts import OP, SPANDATA
+from sentry_sdk.consts import _SENTRY_HEADER_NAMES, OP, SPANDATA
 from sentry_sdk.integrations import Integration
 from sentry_sdk.scope import add_global_event_processor
 from sentry_sdk.traces import StreamedSpan
-from sentry_sdk.tracing import BAGGAGE_HEADER_NAME, SENTRY_TRACE_HEADER_NAME
+from sentry_sdk.tracing import SENTRY_TRACE_HEADER_NAME
 from sentry_sdk.tracing_utils import (
     EnvironHeaders,
     add_http_breadcrumb,
@@ -41,9 +41,6 @@
     "version": "%s.%s.%s" % (sys.version_info[:3]),
     "build": sys.version,
 }
-
-_SENTRY_HEADER_NAMES = frozenset((BAGGAGE_HEADER_NAME, SENTRY_TRACE_HEADER_NAME))
-
 try:
     from botocore.awsrequest import AWSHTTPConnection, AWSHTTPSConnection
 except ImportError: