fix(opentelemetry-instrumentation-asgi): Correct http.url attribute generation #2477
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
dhofstetter
force-pushed
the
fix/asgi-sub-apps
branch
3 times, most recently
from
4271c3e
to
ffe44f8
Compare
|
pylint forced me to split the fastapi instrumentation tests, therefore I made a split into two files |
|
pipeline is already running 100% green within my fork, so its safe to approve workflows |
xrmx
reviewed
Apr 30, 2024
...tation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
Outdated
Show resolved
Hide resolved
...tation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
Outdated
Show resolved
Hide resolved
|
@samuelcolvin any chance you could take a look at this? |
|
I'll check this today. |
|
@Kludex it would be great if you can take a look at this, thanks |
Kludex
approved these changes
May 15, 2024
…e generation even with sub apps (fixes open-telemetry#2476) - modify the instrumentation logic - add unittests on starlette instrumentation - add unittests on fastapi instrumentation
dhofstetter
force-pushed
the
fix/asgi-sub-apps
branch
from
ffe44f8
to
1970a3f
Compare
Changed the comments to prevent non required verbosity :) |
|
Refactored as suggested and rebased to main |
Kludex
approved these changes
May 22, 2024
xrmx
reviewed
May 28, 2024
| @@ -485,6 +580,58 @@ def tearDown(self): | |||
| self._instrumentor.uninstrument() | |||
| super().tearDown() | |||
|
|
|||
| def test_sub_app_fastapi_call(self): | |||
There was a problem hiding this comment.
If this is the very same code of the TestAutoInstrumentation method we should probably rethink the inheritance of these tests cases
There was a problem hiding this comment.
something like this unless we are supposed to rerun the same tests many times:
diff --git a/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py b/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py
index 4269dfa2..9c396c66 100644
--- a/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py
+++ b/instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py
@@ -61,7 +61,7 @@ _recommended_attrs = {
}
-class TestFastAPIManualInstrumentation(TestBase):
+class TestBaseFastAPI:
def _create_app(self):
app = self._create_fastapi_app()
self._instrumentor.instrument_app(
@@ -109,6 +109,30 @@ class TestFastAPIManualInstrumentation(TestBase):
self._instrumentor.uninstrument()
self._instrumentor.uninstrument_app(self._app)
+ @staticmethod
+ def _create_fastapi_app():
+ app = fastapi.FastAPI()
+
+ @app.get("/foobar")
+ async def _():
+ return {"message": "hello world"}
+
+ @app.get("/user/{username}")
+ async def _(username: str):
+ return {"message": username}
+
+ @app.get("/exclude/{param}")
+ async def _(param: str):
+ return {"message": param}
+
+ @app.get("/healthzz")
+ async def _():
+ return {"message": "ok"}
+
+ return app
+
+
+class TestFastAPIManualInstrumentation(TestBaseFastAPI, TestBase):
def test_instrument_app_with_instrument(self):
if not isinstance(self, TestAutoInstrumentation):
self._instrumentor.instrument()
@@ -310,30 +334,8 @@ class TestFastAPIManualInstrumentation(TestBase):
if isinstance(point, NumberDataPoint):
self.assertEqual(point.value, 0)
- @staticmethod
- def _create_fastapi_app():
- app = fastapi.FastAPI()
-
- @app.get("/foobar")
- async def _():
- return {"message": "hello world"}
-
- @app.get("/user/{username}")
- async def _(username: str):
- return {"message": username}
-
- @app.get("/exclude/{param}")
- async def _(param: str):
- return {"message": param}
-
- @app.get("/healthzz")
- async def _():
- return {"message": "ok"}
-
- return app
-
-class TestFastAPIManualInstrumentationHooks(TestFastAPIManualInstrumentation):
+class TestFastAPIManualInstrumentationHooks(TestBaseFastAPI, TestBase):
_server_request_hook = None
_client_request_hook = None
_client_response_hook = None
@@ -383,7 +385,7 @@ class TestFastAPIManualInstrumentationHooks(TestFastAPIManualInstrumentation):
)
-class TestAutoInstrumentation(TestFastAPIManualInstrumentation):
+class TestAutoInstrumentation(TestBaseFastAPI, TestBase):
"""Test the auto-instrumented variant
Extending the manual instrumentation as most test cases apply
@@ -445,7 +447,7 @@ class TestAutoInstrumentation(TestFastAPIManualInstrumentation):
super().tearDown()
-class TestAutoInstrumentationHooks(TestFastAPIManualInstrumentationHooks):
+class TestAutoInstrumentationHooks(TestBaseFastAPI, TestBase):
"""
Test the auto-instrumented variant for request and response hooks
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
Correct http.url and http.target attribute generation even with sub apps (fixes #2476)
Fixes #2476
Type of change
Please delete options that are not relevant.
From my point of view existing logic won't break. Simply attributes generated will change according to their correct intended values.
How Has This Been Tested?
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.