Skip to content

httpx: add the is_instrumented flag to the transport #3106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

httpx: add the is_instrumented flag to the transport #3106

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7f552db
httpx: instrument transport instead of client
Kludex Dec 13, 2024
3902028
And now?
Kludex Dec 13, 2024
70e8cab
fix typo
Kludex Dec 13, 2024
ee2ec22
Merge branch 'main' into instrument-transport-instead-of-client
Kludex Dec 13, 2024
de40117
Move the test around
Kludex Dec 13, 2024
4f3b83d
try to fix the issue
Kludex Dec 13, 2024
e5f1579
fix issue
Kludex Dec 13, 2024
f42c678
make sure that test fails
Kludex Dec 13, 2024
52471f9
make sure that test fails
Kludex Dec 13, 2024
f209059
Transport was not being passed...
Kludex Dec 13, 2024
ed97732
Fix test
Kludex Dec 13, 2024
b89ee8f
Add changelog entry
Kludex Dec 13, 2024
7660a00
Do nothing on transport already instrumented
Kludex Dec 13, 2024
cd925e7
Empty-Commit
Kludex Dec 16, 2024
9378dfd
Add _is_instrumented_by_opentelemetry to the transport
Kludex Dec 16, 2024
9ed3ebb
Merge branch 'main' into instrument-transport-instead-of-client
Kludex Dec 16, 2024
7095cd0
Update CHANGELOG.md
Kludex Dec 16, 2024
da3545e
Merge branch 'main' into instrument-transport-instead-of-client
xrmx Dec 18, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix test
  • Loading branch information
@Kludex
Kludex committed Dec 13, 2024
commit ed97732e6dec8b75ec4e47c49be5b6c83730cd0f
12 changes: 7 additions & 5 deletions ...n/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,9 @@ def instrument_client(
that is called right before the span ends
"""

if getattr(client, "_is_instrumented_by_opentelemetry", False):
if getattr(
client._transport, "_is_instrumented_by_opentelemetry", False
):
_logger.warning(
Copy link
Contributor

@alexmojaki alexmojaki Dec 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't log a warning if someone instruments a new client with the same transport. So I think we need to keep the attribute and warning on the client, but silently do nothing if the transport is already instrumented.
"Attempting to instrument Httpx client while already instrumented"
)
Expand Down Expand Up @@ -946,7 +948,7 @@ def instrument_client(
response_hook=response_hook,
),
)
client._is_instrumented_by_opentelemetry = True
client._transport._is_instrumented_by_opentelemetry = True
if hasattr(client._transport, "handle_async_request"):
wrap_function_wrapper(
client._transport,
Expand All @@ -972,7 +974,7 @@ def instrument_client(
async_response_hook=async_response_hook,
),
)
client._is_instrumented_by_opentelemetry = True
client._transport._is_instrumented_by_opentelemetry = True

@staticmethod
def uninstrument_client(
Expand All @@ -987,9 +989,9 @@ def uninstrument_client(
unwrap(client._transport, "handle_request")
for transport in client._mounts.values():
unwrap(transport, "handle_request")
client._is_instrumented_by_opentelemetry = False
client._transport._is_instrumented_by_opentelemetry = False
elif hasattr(client._transport, "handle_async_request"):
unwrap(client._transport, "handle_async_request")
for transport in client._mounts.values():
unwrap(transport, "handle_async_request")
client._is_instrumented_by_opentelemetry = False
client._transport._is_instrumented_by_opentelemetry = False
Loading