Skip to content

Commit

Permalink
Allow custom transaction names in asgi (#3664)
Browse files Browse the repository at this point in the history
  • Loading branch information
sl0thentr0py authored Oct 16, 2024
1 parent e463034 commit f493057
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
2 changes: 2 additions & 0 deletions sentry_sdk/integrations/asgi.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
TRANSACTION_SOURCE_ROUTE,
TRANSACTION_SOURCE_URL,
TRANSACTION_SOURCE_COMPONENT,
TRANSACTION_SOURCE_CUSTOM,
)
from sentry_sdk.utils import (
ContextVar,
Expand Down Expand Up @@ -274,6 +275,7 @@ def event_processor(self, event, hint, asgi_scope):
].get("source") in [
TRANSACTION_SOURCE_COMPONENT,
TRANSACTION_SOURCE_ROUTE,
TRANSACTION_SOURCE_CUSTOM,
]
if not already_set:
name, source = self._get_transaction_name_and_source(
Expand Down
42 changes: 42 additions & 0 deletions tests/integrations/asgi/test_asgi.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,31 @@ async def app(scope, receive, send):
return app


@pytest.fixture
def asgi3_custom_transaction_app():

async def app(scope, receive, send):
sentry_sdk.get_current_scope().set_transaction_name("foobar", source="custom")
await send(
{
"type": "http.response.start",
"status": 200,
"headers": [
[b"content-type", b"text/plain"],
],
}
)

await send(
{
"type": "http.response.body",
"body": b"Hello, world!",
}
)

return app


def test_invalid_transaction_style(asgi3_app):
with pytest.raises(ValueError) as exp:
SentryAsgiMiddleware(asgi3_app, transaction_style="URL")
Expand Down Expand Up @@ -679,3 +704,20 @@ def dummy_traces_sampler(sampling_context):

async with TestClient(app) as client:
await client.get(request_url)


@pytest.mark.asyncio
async def test_custom_transaction_name(
sentry_init, asgi3_custom_transaction_app, capture_events
):
sentry_init(traces_sample_rate=1.0)
events = capture_events()
app = SentryAsgiMiddleware(asgi3_custom_transaction_app)

async with TestClient(app) as client:
await client.get("/test")

(transaction_event,) = events
assert transaction_event["type"] == "transaction"
assert transaction_event["transaction"] == "foobar"
assert transaction_event["transaction_info"] == {"source": "custom"}

0 comments on commit f493057

Please sign in to comment.