FastAPI: capture custom request response headers in span attributes #1032
Conversation
This file contains 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
lzchen
approved these changes
Apr 6, 2022
… websocket app with custom request/response headers
ashu658
reviewed
Apr 8, 2022
instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py
Show resolved
Hide resolved
|
|
||
| def tearDown(self) -> None: | ||
| super().tearDown() | ||
| self.env_patch.stop() |
There was a problem hiding this comment.
App should be uninstrumented in teardown. (example)
ashu658
approved these changes
Apr 8, 2022
|
@lzchen, @srikanthccv Please do review this PR and if it looks fine, please do merge it |
# for free
to join this conversation on GitHub.
Already have an account?
# 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
This PR contains py tests for FastAPI framework. Actual code has been merged in this PR: capture custom request response header for ASGI
It also contains the doc update for FastAPI as well as for ASGI framework
Fixes #916
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Added unit tests for request and response headers for http and websocket applications.
Same test cases for both http/websocket application
Test A: check for request header which is set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST env variable, is present in the span as attribute
Test B: check for request header which is NOT set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST env variable, is NOT present in the span as attribute
Test C: check for response header which is set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE env variable, is present in the span as attribute
Test D: check for response header which is NOT set in OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE env variable, is NOT present in the span as attribute
Does This PR Require a Core Repo Change?
Checklist: