starlette/fastapi: fix error on host-based routing #3507
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xrmx
reviewed
May 21, 2025
| def test_host_fastapi_call(self): | ||
| client = TestClient(self._app, base_url="https://testserver2") | ||
| client.get("/") | ||
|
|
There was a problem hiding this comment.
I think we should add some assertions here, especially for HTTP_ROUTE
There was a problem hiding this comment.
Sure! The thing is I don't really understand how spans are working in the test above 😊 Can you give me a rough idea of how to start?
There was a problem hiding this comment.
Hi @frankie567 , some of the instrumentor tests are using a TestBase that can set up an in-memory span exporter. The test above uses this to get spans from an instrumented client then check its attributes.
|
Hey @frankie567, do you plan to update the PR after review? |
|
@xrmx Yes, sorry, got a bit busy lately; but I'll try to finish this by next week. |
xrmx
reviewed
Jun 30, 2025
| @@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 | |||
| - `opentelemetry-instrumentation-botocore` Use `cloud.region` instead of `aws.region` span attribute as per semantic conventions. | |||
| ([#3474](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3474)) | |||
|
|
|||
| ### Fixed | |||
|
|
|||
| - `opentelemetry-instrumentation-starlette` Fixes a crash when host-based routing is used ([#3507](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3507/)) | |||
There was a problem hiding this comment.
These needs to be moved to unreleased
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Handle case where the Starlette/FastAPI app uses a hosted-based routing. In this case, there is no
pathattribute to read from the routing class. Therefore, fallback to the path present inscope. The fix is inspired from what Sentry did to fix a similar bug: https://github.com/getsentry/sentry-python/blob/312f85739af27bb9665f61fedd9a589178a67000/sentry_sdk/integrations/starlette.py#L696-L700Fixes #3506
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Added basic unit tests to assess the instrument not longer crashes when a host-based route is called.
Note
I've not added assertions regarding the collected spans/traces, wasn't really sure where to start. But happy to improve that with some guidance :)
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.
[ ] Documentation has been updated(not relevant)