feat: Add tracing and transaction names to aiohttp (getsentry#467)

untitaker · web-flow · commit 9acc1195f538 · 2019-08-13T23:14:22.000+02:00
diff --git a/mypy.ini b/mypy.ini
@@ -35,6 +35,10 @@ disallow_untyped_defs = False
 disallow_any_generics = False
 disallow_untyped_defs = False
 
+[mypy-sentry_sdk.integrations.aiohttp]
+disallow_any_generics = True
+disallow_untyped_defs = True
+
 [mypy-sentry_sdk.utils]
 disallow_any_generics = False
 disallow_untyped_defs = False
diff --git a/sentry_sdk/integrations/aiohttp.py b/sentry_sdk/integrations/aiohttp.py
@@ -9,22 +9,25 @@
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     event_from_exception,
+    transaction_from_function,
     HAS_REAL_CONTEXTVARS,
 )
 
 import asyncio
-from aiohttp.web import Application, HTTPException  # type: ignore
+from aiohttp.web import Application, HTTPException, UrlDispatcher  # type: ignore
 
 from sentry_sdk._types import MYPY
 
 if MYPY:
     from aiohttp.web_request import Request  # type: ignore
+    from aiohttp.abc import AbstractMatchInfo  # type: ignore
     from typing import Any
     from typing import Dict
     from typing import Tuple
     from typing import Callable
 
     from sentry_sdk.utils import ExcInfo
+    from sentry_sdk._types import EventProcessor
 
 
 class AioHttpIntegration(Integration):
@@ -60,14 +63,17 @@ async def inner():
                         scope.clear_breadcrumbs()
                         scope.add_event_processor(_make_request_processor(weak_request))
 
-                    try:
-                        response = await old_handle(self, request)
-                    except HTTPException:
-                        raise
-                    except Exception:
-                        reraise(*_capture_exception(hub))
+                    # If this transaction name makes it to the UI, AIOHTTP's
+                    # URL resolver did not find a route or died trying.
+                    with hub.span(transaction="generic AIOHTTP request"):
+                        try:
+                            response = await old_handle(self, request)
+                        except HTTPException:
+                            raise
+                        except Exception:
+                            reraise(*_capture_exception(hub))
 
-                    return response
+                        return response
 
             # Explicitly wrap in task such that current contextvar context is
             # copied. Just doing `return await inner()` will leak scope data
@@ -76,9 +82,30 @@ async def inner():
 
         Application._handle = sentry_app_handle
 
+        old_urldispatcher_resolve = UrlDispatcher.resolve
+
+        async def sentry_urldispatcher_resolve(self, request):
+            # type: (UrlDispatcher, Request) -> AbstractMatchInfo
+            rv = await old_urldispatcher_resolve(self, request)
+
+            name = None
+
+            try:
+                name = transaction_from_function(rv.handler)
+            except Exception:
+                pass
+
+            if name is not None:
+                with Hub.current.configure_scope() as scope:
+                    scope.transaction = name
+
+            return rv
+
+        UrlDispatcher.resolve = sentry_urldispatcher_resolve
+
 
 def _make_request_processor(weak_request):
-    # type: (Callable[[], Request]) -> Callable
+    # type: (Callable[[], Request]) -> EventProcessor
     def aiohttp_processor(
         event,  # type: Dict[str, Any]
         hint,  # type: Dict[str, Tuple[type, BaseException, Any]]
diff --git a/tests/integrations/aiohttp/test_aiohttp.py b/tests/integrations/aiohttp/test_aiohttp.py
@@ -20,6 +20,11 @@ async def hello(request):
 
     event, = events
 
+    assert (
+        event["transaction"]
+        == "tests.integrations.aiohttp.test_aiohttp.test_basic.<locals>.hello"
+    )
+
     exception, = event["exception"]["values"]
     assert exception["type"] == "ZeroDivisionError"
     request = event["request"]
@@ -72,3 +77,27 @@ async def hello(request):
     assert resp.status == 200
 
     assert events == []
+
+
+async def test_tracing(sentry_init, aiohttp_client, loop, capture_events):
+    sentry_init(integrations=[AioHttpIntegration()], traces_sample_rate=1.0)
+
+    async def hello(request):
+        return web.Response(text="hello")
+
+    app = web.Application()
+    app.router.add_get("/", hello)
+
+    events = capture_events()
+
+    client = await aiohttp_client(app)
+    resp = await client.get("/")
+    assert resp.status == 200
+
+    event, = events
+
+    assert event["type"] == "transaction"
+    assert (
+        event["transaction"]
+        == "tests.integrations.aiohttp.test_aiohttp.test_tracing.<locals>.hello"
+    )
