fix(spans): Add http.route attribute to HTTP server spans

Author: mjq

sentry_sdk/consts.py

@@ -878,6 +878,12 @@ class SPANDATA:
     Example: GET
     """
 
+    HTTP_ROUTE = "http.route"
+    """
+    The matched route, that is, the path template used to match the request.
+    Example: /users/{id}
+    """
+
     HTTP_QUERY = "http.query"
     """
     The Query string present in the URL.

sentry_sdk/integrations/asgi.py

@@ -246,13 +246,19 @@ async def _run_app(
                     span_ctx: "ContextManager[Union[Span, StreamedSpan, None]]"
                     if span_streaming:
                         segment: "Optional[StreamedSpan]" = None
+                        segment_source = getattr(
+                            transaction_source, "value", transaction_source
+                        )
                         attributes: "Attributes" = {
-                            "sentry.segment.name.source": getattr(
-                                transaction_source, "value", transaction_source
-                            ),
+                            "sentry.segment.name.source": segment_source,
                             "sentry.origin": self.span_origin,
                             "network.protocol.name": ty,
                         }
+                        if (
+                            segment_source == SegmentNameSource.ROUTE.value
+                            and transaction_name != _DEFAULT_TRANSACTION_NAME
+                        ):
+                            attributes[SPANDATA.HTTP_ROUTE] = transaction_name
 
                         if scope.get("client"):
                             client_options = sentry_sdk.get_client().options
@@ -412,6 +418,13 @@ async def _sentry_wrapped_send(
                                         span.set_attribute(
                                             "sentry.segment.name.source", source
                                         )
+                                        if (
+                                            source == SegmentNameSource.ROUTE.value
+                                            and name != _DEFAULT_TRANSACTION_NAME
+                                        ):
+                                            span.set_attribute(
+                                                SPANDATA.HTTP_ROUTE, name
+                                            )
         finally:
             _asgi_middleware_applied.set(False)
 

sentry_sdk/scope.py

@@ -31,6 +31,7 @@
 from sentry_sdk.traces import (
     _DEFAULT_PARENT_SPAN,
     NoOpStreamedSpan,
+    SegmentNameSource,
     StreamedSpan,
 )
 from sentry_sdk.tracing import (
@@ -862,9 +863,12 @@ def set_transaction_name(self, name: str, source: "Optional[str]" = None) -> Non
             if isinstance(self._span, StreamedSpan):
                 self._span._segment.name = name
                 if source:
+                    source_value = getattr(source, "value", source)
                     self._span._segment.set_attribute(
-                        "sentry.segment.name.source", getattr(source, "value", source)
+                        "sentry.segment.name.source", source_value
                     )
+                    if source_value == SegmentNameSource.ROUTE.value:
+                        self._span._segment.set_attribute(SPANDATA.HTTP_ROUTE, name)
 
             elif self._span.containing_transaction:
                 self._span.containing_transaction.name = name

tests/integrations/asgi/test_asgi.py

@@ -670,6 +670,7 @@ async def test_transaction_style(
 
         assert span["name"] == expected_transaction
         assert span["attributes"]["sentry.segment.name.source"] == expected_source
+        assert "http.route" not in span["attributes"]
 
     else:
         (transaction_event,) = events
@@ -678,6 +679,40 @@ async def test_transaction_style(
         assert transaction_event["transaction_info"] == {"source": expected_source}
 
 
+@pytest.mark.asyncio
+async def test_http_route_set_for_route_segment_name(
+    sentry_init,
+    asgi3_app,
+    capture_items,
+):
+    sentry_init(
+        traces_sample_rate=1.0,
+        trace_lifecycle="stream",
+    )
+    app = SentryAsgiMiddleware(asgi3_app, transaction_style="url")
+
+    class Route:
+        path = "/message/{message_id}"
+
+    scope = {
+        "endpoint": asgi3_app,
+        "route": Route(),
+        "client": ("127.0.0.1", 60457),
+    }
+
+    async with TestClient(app, scope=scope) as client:
+        items = capture_items("span")
+        await client.get("/message/123456")
+
+    sentry_sdk.flush()
+
+    assert len(items) == 1
+    span = items[0].payload
+    assert span["name"] == "/message/{message_id}"
+    assert span["attributes"]["sentry.segment.name.source"] == "route"
+    assert span["attributes"]["http.route"] == "/message/{message_id}"
+
+
 def mock_asgi2_app():
     pass
 

tests/integrations/django/test_basic.py

@@ -1276,6 +1276,10 @@ def test_transaction_style(
 
         assert spans[2]["is_segment"] is True
         assert spans[2]["attributes"]["sentry.segment.name.source"] == expected_source
+        if expected_source == "route":
+            assert spans[2]["attributes"]["http.route"] == expected_transaction
+        else:
+            assert "http.route" not in spans[2]["attributes"]
 
         (event,) = (item.payload for item in items if item.type == "event")
     else:

tests/integrations/fastapi/test_fastapi.py

@@ -770,6 +770,7 @@ async def get_user(user_id: int):
         segment = segments[0]
         assert segment["name"] == "/api/users/{user_id}"
         assert segment["attributes"]["sentry.segment.name.source"] == "route"
+        assert segment["attributes"]["http.route"] == "/api/users/{user_id}"
     else:
         (transaction_envelope,) = envelopes
         transaction_event = transaction_envelope.get_transaction_event()

tests/integrations/flask/test_flask.py

@@ -135,6 +135,10 @@ def test_transaction_or_segment_style(
         (segment,) = spans
         assert segment["name"] == expected_transaction
         assert segment["attributes"]["sentry.segment.name.source"] == expected_source
+        if expected_source == "route":
+            assert segment["attributes"]["http.route"] == expected_transaction
+        else:
+            assert "http.route" not in segment["attributes"]
     else:
         (_, event) = events
         assert event["transaction"] == expected_transaction