feat: Add path parameter rendering feature #2879
Open
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
In the current version, path parameters are not rendered properly in the span name (e.g.,
GET /api/{userId}
), leading to confusion for users who expect to see the relevant path information. This issue particularly affects scenarios where dynamic paths are generated.To address this, a new optional boolean parameter, render_path_parameters, has been added to enable or disable the rendering of path parameters in the span name:
With this change, the spanName
GET /api/{userId}
will be recorded asGET /api/123456
.Type of change
How Has This Been Tested?
Unit tests have been added to ensure that path parameters render correctly in different scenarios.
TestFastAPIRenderPathParameters
in ’tests/test_fastapi_instrumentation.py`Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.