Skip to content

opentelemetry-instrumentation-psycopg claims to work for async queries, but doesn't record time #2486

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Open
samuelcolvin opened this issue May 1, 2024 · 3 comments · May be fixed by #3324
Open

opentelemetry-instrumentation-psycopg claims to work for async queries, but doesn't record time #2486

samuelcolvin opened this issue May 1, 2024 · 3 comments · May be fixed by #3324
Labels
bug Something isn't working

Comments

@samuelcolvin
Copy link
Contributor

This was orignally reported as pydantic/logfire#65 which has version details etc.

But in summary, using opentelemetry-instrumentation-psycopg="0.45b0" to instrument asyncio queries, doesn't work properly.

The cause is as follows:

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-psycopg/src/opentelemetry/instrumentation/psycopg/__init__.py

Lines 335 to 338 in 5116305

async def execute(self, *args, **kwargs):
return await _cursor_tracer.traced_execution(
self, super().execute, *args, **kwargs
)

calls

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

Lines 472 to 475 in 5116305

def execute(self, *args, **kwargs):
return _cursor_tracer.traced_execution(
self.__wrapped__, self.__wrapped__.execute, *args, **kwargs
)

calls

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

Lines 408 to 414 in 5116305

def traced_execution(
self,
cursor,
query_method: typing.Callable[..., typing.Any],
*args: typing.Tuple[typing.Any, typing.Any],
**kwargs: typing.Dict[typing.Any, typing.Any],
):

which isn't designed to support an awaitable query_method, so it immediately returns a future, which gets awaited after the span has closed, hence zero time spans:

From Logfire, we see:
image

when we'd expect something similar to what's observed with sync calls:
image

I'm not clear why TracedCursorProxy is required rather than just using CursorTracer, but either way, I'd suggest implementing an async varient of traced_execution which tries to share as much logic as possible with the sync method.

If you agree, I'll try to create a PR for this over the next week or so.
@samuelcolvin samuelcolvin added the bug Something isn't working label May 1, 2024
@samuelcolvin samuelcolvin mentioned this issue May 1, 2024
Closed
@xrmx
Copy link
Contributor

xrmx commented May 13, 2024

cc @federicobond

@federicobond
Copy link
Member

Thanks for the ping @xrmx. Agree that this is a bug and your proposed solution sounds reasonable @samuelcolvin, happy to review your PR

@Kludex Kludex mentioned this issue Dec 4, 2024
Merged
@Kludex
Copy link
Contributor

Kludex commented Dec 10, 2024 •
edited
Loading

If someone can review this: #3067, and #3068... I'm happy to work on this, properly.

Also, knowing the reason for TracedCursorProxy would be nice.

ibash added a commit to ibash/opentelemetry-python-contrib that referenced this issue Mar 4, 2025
@ibash
Fix tracing of async cursors for psycopg
dbd1d23 
This copies the traced_execution of AsyncCursorTracer except
query_method is awaited within the span.

Fixes open-telemetry#2486
@ibash ibash linked a pull request Mar 4, 2025 that will close this issue
Open
7 tasks
ibash added a commit to ibash/opentelemetry-python-contrib that referenced this issue Mar 5, 2025
@ibash
Fix tracing of async cursors for psycopg
ecea87a 
This copies the traced_execution of AsyncCursorTracer except
query_method is awaited within the span.

Fixes open-telemetry#2486
ibash added a commit to ibash/opentelemetry-python-contrib that referenced this issue Mar 25, 2025
@ibash
Fix tracing of async cursors for psycopg
71f50a7 
This copies the traced_execution of AsyncCursorTracer except
query_method is awaited within the span.

Fixes open-telemetry#2486
ibash added a commit to ibash/opentelemetry-python-contrib that referenced this issue Mar 25, 2025
@ibash
Fix tracing of async cursors for psycopg
0817e6c 
This copies the traced_execution of AsyncCursorTracer except
query_method is awaited within the span.

Fixes open-telemetry#2486
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix tracing of async cursors for psycopg ibash/opentelemetry-python-contrib
4 participants
@xrmx @federicobond @samuelcolvin @Kludex