Use canonical name for aiohttp request span name #3896
+63
−1
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
|
|
krnr
force-pushed
the
main
branch
4 times, most recently
from
02658f3 to
1ba9a1c
Compare
bisgaard-itis
approved these changes
Oct 26, 2025
| for request_path, span in zip( | ||
| example_paths, memory_exporter.get_finished_spans() | ||
| ): | ||
| assert url == span.name |
| a tuple of the span name, and any attributes to attach to the span. | ||
| """ | ||
| span_name = request.path.strip() or f"HTTP {request.method}" | ||
| if request.match_info and request.match_info.route.resource: |
There was a problem hiding this comment.
Is match_info.route guaranteed to be not None when match_info is not None?
There was a problem hiding this comment.
thank you for the good point. i think this can be the proof: https://github.com/aio-libs/aiohttp/blob/master/aiohttp/web_urldispatcher.py#L231
(in fact, even match_info can't be None: https://github.com/aio-libs/aiohttp/blob/v3.13.1/aiohttp/web_request.py#L890 but it may raise issues with type hints)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Current implementation doesn't use canonical attribute of a
Resource, which leads to the situation when generated spans all have unique names. It creates high cardinality of spans. Other frameworks that use path params create spans with "canonical" paths in names (e.g. fastapi [1] )Type of change
How Has This Been Tested?
add a new unit test:
test_url_params_instrumentationDoes This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.