Skip to content

feat(litestar): Set name and source on route span when streaming #6553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexander-alderman-webb wants to merge 2 commits into
base: master
Choose a base branch
from
+86 −26
Open

feat(litestar): Set name and source on route span when streaming #6553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8121c6d
feat(litestar): Set name and source on route span when streaming
alexander-alderman-webb Jun 10, 2026
35130d2
.
alexander-alderman-webb Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 23 additions & 26 deletions sentry_sdk/integrations/litestar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,40 +287,37 @@ async def handle_wrapper(

request_data = await body

def event_processor(event: "Event", _: "Hint") -> "Event":
route_handler = scope.get("route_handler")
route_handler = scope.get("route_handler")

func = None
if route_handler.name is not None:
name = route_handler.name
# Accounts for use of type `Ref` in earlier versions of litestar without the need to reference it as a type
elif hasattr(route_handler.fn, "value"):
func = route_handler.fn.value
else:
func = route_handler.fn
if func is not None:
name = transaction_from_function(func)

source = SOURCE_FOR_STYLE["endpoint"]

if not name:
name = _DEFAULT_TRANSACTION_NAME
source = TransactionSource.ROUTE

sentry_sdk.set_transaction_name(name, source)
sentry_scope.set_transaction_name(name, source)

def event_processor(event: "Event", _: "Hint") -> "Event":
request_info = event.get("request", {})
request_info["content_length"] = len(scope.get("_body", b""))
if should_send_default_pii():
request_info["cookies"] = extracted_request_data["cookies"]
if request_data is not None:
request_info["data"] = request_data
Comment thread
alexander-alderman-webb marked this conversation as resolved.

func = None
if route_handler.name is not None:
tx_name = route_handler.name
# Accounts for use of type `Ref` in earlier versions of litestar without the need to reference it as a type
elif hasattr(route_handler.fn, "value"):
func = route_handler.fn.value
else:
func = route_handler.fn
if func is not None:
tx_name = transaction_from_function(func)

tx_info = {"source": SOURCE_FOR_STYLE["endpoint"]}

if not tx_name:
tx_name = _DEFAULT_TRANSACTION_NAME
tx_info = {"source": TransactionSource.ROUTE}

event.update(
{
"request": deepcopy(request_info),
"transaction": tx_name,
"transaction_info": tx_info,
}
)
event["request"] = deepcopy(request_info)
return event

sentry_scope._name = LitestarIntegration.identifier
Expand Down
63 changes: 63 additions & 0 deletions tests/integrations/litestar/test_litestar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,69 @@ def test_catch_exceptions(
assert event["exception"]["values"][0]["mechanism"]["type"] == "litestar"


@pytest.mark.parametrize(
"test_url,expected_tx_name",
[
(
"/some_url",
"tests.integrations.litestar.test_litestar.litestar_app_factory.<locals>.homepage_handler",
),
(
"/custom_error",
"custom_name",
),
(
"/controller/error",
"tests.integrations.litestar.test_litestar.litestar_app_factory.<locals>.MyController.controller_error",
),
],
)
@pytest.mark.parametrize("span_streaming", [True, False])
def test_transaction_name_and_source(
sentry_init,
capture_events,
test_url,
expected_tx_name,
capture_items,
span_streaming,
):
sentry_init(
traces_sample_rate=1.0,
integrations=[LitestarIntegration()],
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
litestar_app = litestar_app_factory()
client = TestClient(litestar_app)

if span_streaming:
items = capture_items("span")

try:
client.get(test_url)
except Exception:
pass

sentry_sdk.flush()
spans = [item.payload for item in items]

spans = [span for span in spans if expected_tx_name in span["name"]]
assert len(spans) == 1
assert spans[0]["attributes"]["sentry.span.source"] == "component"
else:
events = capture_events()

try:
client.get(test_url)
except Exception:
pass

(_, transaction) = events
assert expected_tx_name in transaction["transaction"]
assert transaction["transaction_info"] == {"source": "component"}


@pytest.mark.parametrize("span_streaming", [True, False])
def test_middleware_spans(
sentry_init,
Expand Down
Loading