feat(aiohttp,sanic,tornado): Add user_agent.original attr for inbound filters (#7795)

Bunched these three together since it's a very small change in each

Part 3 of
https://linear.app/getsentry/issue/PY-2898/implement-user-agentoriginal

Author: sentrivana

sentry_sdk/integrations/aiohttp.py

@@ -158,6 +158,10 @@ async def sentry_app_handle(
                         ),
                     )
 
+                    user_agent = request.headers.get("User-Agent")
+                    if user_agent:
+                        scope.set_attribute(SPANDATA.USER_AGENT_ORIGINAL, user_agent)
+
                     headers = dict(request.headers)
 
                     span_ctx: "ContextManager[Union[Span, StreamedSpan]]"

sentry_sdk/integrations/sanic.py

@@ -193,6 +193,10 @@ async def _context_enter(request: "Request") -> None:
         ),
     )
 
+    user_agent = request.headers.get("user-agent")
+    if user_agent:
+        scope.set_attribute(SPANDATA.USER_AGENT_ORIGINAL, user_agent)
+
     if is_span_streaming_enabled:
         integration = client.get_integration(SanicIntegration)
         if (

sentry_sdk/integrations/tornado.py

@@ -137,6 +137,10 @@ def _handle_request_impl(self: "RequestHandler") -> "Generator[None, None, None]
             ),
         )
 
+        user_agent = headers.get("User-Agent")
+        if user_agent:
+            scope.set_attribute(SPANDATA.USER_AGENT_ORIGINAL, user_agent)
+
         span_ctx: "ContextManager[Union[Span, StreamedSpan, None]]"
 
         if is_span_streaming_enabled:

tests/integrations/aiohttp/test_aiohttp.py

@@ -2472,6 +2472,44 @@ async def hello(request):
     assert child_spans[0]["attributes"][SPANDATA.SENTRY_IS_LOCALHOST] == is_localhost
 
 
+@pytest.mark.asyncio
+async def test_user_agent_attribute(sentry_init, aiohttp_client, capture_items):
+    sentry_init(
+        integrations=[AioHttpIntegration()],
+        traces_sample_rate=1.0,
+        trace_lifecycle="stream",
+    )
+
+    async def hello(request):
+        with sentry_sdk.traces.start_span(name="child"):
+            pass
+        return web.Response(text="hello")
+
+    app = web.Application()
+    app.router.add_get("/", hello)
+
+    items = capture_items("span")
+
+    client = await aiohttp_client(app)
+    resp = await client.get("/", headers={"User-Agent": "TestBrowser/1.0"})
+    assert resp.status == 200
+
+    sentry_sdk.flush()
+
+    child_spans = [item.payload for item in items if not item.payload.get("is_segment")]
+    server_spans = [item.payload for item in items if item.payload.get("is_segment")]
+
+    assert len(server_spans) == 1
+    assert len(child_spans) == 1
+
+    assert (
+        server_spans[0]["attributes"][SPANDATA.USER_AGENT_ORIGINAL] == "TestBrowser/1.0"
+    )
+    assert (
+        child_spans[0]["attributes"][SPANDATA.USER_AGENT_ORIGINAL] == "TestBrowser/1.0"
+    )
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
     "init_kwargs, expect_remote_addr", DATA_COLLECTION_REMOTE_ADDR_CASES

tests/integrations/sanic/test_sanic.py

@@ -943,3 +943,37 @@ def child_span_handler_localhost(request):
 
     assert server_span["attributes"]["sentry.is_localhost"] is is_localhost
     assert child_span["attributes"]["sentry.is_localhost"] is is_localhost
+
+
+@pytest.mark.skipif(
+    not PERFORMANCE_SUPPORTED, reason="Performance not supported on this Sanic version"
+)
+def test_user_agent_attribute(sentry_init, app, capture_items):
+    @app.route("/child-span")
+    def child_span_handler_ua(request):
+        with sentry_sdk.traces.start_span(name="child-span"):
+            pass
+        return response.text("ok")
+
+    sentry_init(
+        integrations=[SanicIntegration()],
+        default_integrations=False,
+        traces_sample_rate=1.0,
+        trace_lifecycle="stream",
+    )
+
+    items = capture_items("span")
+
+    c = get_client(app)
+    with c as client:
+        client.get(
+            "/child-span",
+            headers={"User-Agent": "TestBrowser/1.0"},
+        )
+
+    sentry_sdk.flush()
+
+    child_span, server_span = [item.payload for item in items]
+
+    assert server_span["attributes"]["user_agent.original"] == "TestBrowser/1.0"
+    assert child_span["attributes"]["user_agent.original"] == "TestBrowser/1.0"

tests/integrations/tornado/test_tornado.py

@@ -1165,6 +1165,34 @@ def test_is_localhost_span_attribute(
     assert child_spans[0]["attributes"][SPANDATA.SENTRY_IS_LOCALHOST] == is_localhost
 
 
+def test_user_agent_attribute(tornado_testcase, sentry_init, capture_items):
+    sentry_init(
+        integrations=[TornadoIntegration()],
+        traces_sample_rate=1.0,
+        trace_lifecycle="stream",
+    )
+
+    items = capture_items("span")
+
+    client = tornado_testcase(Application([(r"/hi", ChildSpanHandler)]))
+    client.fetch("/hi", headers={"User-Agent": "TestBrowser/1.0"})
+
+    sentry_sdk.flush()
+
+    child_spans = [item.payload for item in items if not item.payload.get("is_segment")]
+    server_spans = [item.payload for item in items if item.payload.get("is_segment")]
+
+    assert len(server_spans) == 1
+    assert len(child_spans) == 1
+
+    assert (
+        server_spans[0]["attributes"][SPANDATA.USER_AGENT_ORIGINAL] == "TestBrowser/1.0"
+    )
+    assert (
+        child_spans[0]["attributes"][SPANDATA.USER_AGENT_ORIGINAL] == "TestBrowser/1.0"
+    )
+
+
 @pytest.mark.parametrize(
     "init_kwargs, expect_remote_addr", DATA_COLLECTION_REMOTE_ADDR_CASES
 )