fix(asyncio integration): Filter SDK internal tasks from span creation #4700

srothh · 2025-08-13T15:12:33Z

Filter SDK internal tasks from span creation. Implements a new contextmanager for tasks spawned internally by the SDK, which filters it in the asyncio integration.

GH-4699

…ted a sync transport HTTP subclass Moved shared sync/async logic into a new superclass (HttpTransportCore), and moved sync transport specific code into a new subclass(BaseSyncHttpTransport), from which the current transport implementations inherit Fixes GH-4568

Removed an unnecessary TODO message and reverted a class name change for BaseHTTPTransport. GH-4568

Adds test coverage for the error handling path when HTTP requests return error status codes. GH-4568

Restore comments accidentally removed during a previous commit.

Refactored class names such that BaseHttpTransport now has the same functionality as before the hierarchy refactor GH-4568

Add a new flush_async method in the Transport ABC. This is needed for the async transport, as calling it from the client while preserving execution order in close will require flush to be a coroutine, not a function. GH-4568

Move flush_async down to the specific async transport subclass. This makes more sense anyway, as this will only be required by the async transport. If more async transports are expected, another shared superclass can be created. GH-4568

Add necessary type annotations to the core HttpTransport to accomodate for async transport. GH-4568

Add an abstract bass class for implementation of the background worker. This was done to provide a shared interface for the current implementation of a threaded worker in the sync context as well as the upcoming async task-based worker implementation. GH-4578

Add a new factory method instead of direct instatiation of the threaded background worker. This allows for easy extension to other types of workers, such as the upcoming task-based async worker. GH-4578

Add a new flush_async method to worker ABC. This is necessary because the async transport cannot use a synchronous blocking flush. GH-4578

Move the flush_async down to the concrete subclass to not break existing testing. This makes sense, as this will only really be needed by the async worker anyway and therefore is not shared logic. GH-4578

Coroutines have a return value, however the current function signature for the worker methods does not accomodate for this. Therefore, this signature was changed. GH-4578

Add a new implementation of the worker interface, implementing the worker as an async task. This is to be used by the upcoming async transport. GH-4581

Refactor the flush method in the async worker to use the async_flush coroutine. GH-4581

…unctions Add a check to see wheter callbacks are awaitable coroutines or functions, as coroutines need to be awaited. GH-4581

…coroutines Coroutines do not return None, therefore it is necessary to consider this in the callback parameter of the worker. Previously, only callbacks with return Type None were accepted. GH-4581

GH-4581

Enable concurrent callbacks on async task worker by firing them as a task rather than awaiting them. A done callback handles the necessary queue and exception logic. GH-4581

Changed kill to also use the _TERMINATOR sentinel, so the queue is still drained to this point on kill instead of cancelled immediately. This should also fix potential race conditions with flush_async. GH-4581

Add proper type annotation to worker task list to fix linting problems GH-4581

Add an implementation of Transport to work with the async background worker and HTTPCore async. GH-4582

Async Transport now properly checks for the presence of the event loop in capture_envelop, and drops items in case the event loop is no longer running for some reason. GH-4582

Implement a kill method that properly shuts down the async transport. The httpcore async connection pool needs to be explicitly shutdown at the end of its usage. GH-4582

Fix type errors resulting from async override and missing type definition in the async transport. GH-4582

Add a try/catch to ensure silent fail on kill in case the event loop shuts down. GH-4582

Fix the event loop check in make_transport so that it does not throw a runtime error but rather falls back correctly. GH-4582

GH-4582

Add a context manager to track internal task creation context. This can be used to track what tasks are created internally by the SDK GH-4699

GH-4699

codecov · 2025-08-13T15:45:11Z

❌ 17 Tests Failed:

Tests completed	Failed	Passed	Skipped
22082	17	22065	1232

View the top 3 failed test(s) by shortest run time

tests.integrations.redis.test_redis::test_pii_data_sent

Stack Traces | 0.082s run time

.../integrations/redis/test_redis.py:149: in test_pii_data_sent
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'

tests.integrations.redis.test_redis::test_breadcrumbs

Stack Traces | 0.083s run time

.../integrations/redis/test_redis.py:231: in test_breadcrumbs
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'

tests.integrations.redis.test_redis::test_redis_pipeline[True-True-expected_first_ten1]

Stack Traces | 0.083s run time

.../integrations/redis/test_redis.py:62: in test_redis_pipeline
    connection = FakeStrictRedis()
.tox/py3.11-redis-v4/lib/python3.11.../site-packages/fakeredis/_connection.py:185: in __init__
    super().__init__(**kwds)
E   TypeError: Redis.__init__() got an unexpected keyword argument 'lib_name'

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

…' into srothh/async-transport-integration

…ask-identifier

…ask-identifier

…k-identifier

srothh added 30 commits July 21, 2025 11:44

ref(transport) Removed Todo and reverted class name change

666ff3a

Removed an unnecessary TODO message and reverted a class name change for BaseHTTPTransport. GH-4568

test(transport): Add test for HTTP error status handling

748764e

Adds test coverage for the error handling path when HTTP requests return error status codes. GH-4568

test(transport): Restore accidentally removed comments

ee6dbee

Restore comments accidentally removed during a previous commit.

ref(transport) Refactor class names to reflect previous functionality

19405fd

Refactored class names such that BaseHttpTransport now has the same functionality as before the hierarchy refactor GH-4568

ref(transport): Add flush_async in the Transport abc

3736c03

Add a new flush_async method in the Transport ABC. This is needed for the async transport, as calling it from the client while preserving execution order in close will require flush to be a coroutine, not a function. GH-4568

ref(transport): Move flush_async from ABC

3607d44

Move flush_async down to the specific async transport subclass. This makes more sense anyway, as this will only be required by the async transport. If more async transports are expected, another shared superclass can be created. GH-4568

ref(transport): add async type annotations to HTTPTransportCore

0ba5a83

Add necessary type annotations to the core HttpTransport to accomodate for async transport. GH-4568

ref(transport): Add _create_worker factory method to Transport

a81487e

Add a new factory method instead of direct instatiation of the threaded background worker. This allows for easy extension to other types of workers, such as the upcoming task-based async worker. GH-4578

ref(worker): Add flush_async method to Worker ABC

8960e6f

Add a new flush_async method to worker ABC. This is necessary because the async transport cannot use a synchronous blocking flush. GH-4578

ref(worker): Move worker flush_async from Worker ABC

0f7937b

Move the flush_async down to the concrete subclass to not break existing testing. This makes sense, as this will only really be needed by the async worker anyway and therefore is not shared logic. GH-4578

ref(worker): Amend function signature for coroutines

268ea1a

Coroutines have a return value, however the current function signature for the worker methods does not accomodate for this. Therefore, this signature was changed. GH-4578

feat(transport): Add an async task-based worker for transport

b3c05cc

Add a new implementation of the worker interface, implementing the worker as an async task. This is to be used by the upcoming async transport. GH-4581

ref(worker): Make worker work with new ABC interface

fb0ad18

Refactor the flush method in the async worker to use the async_flush coroutine. GH-4581

fix(worker): Check if callbacks from worker queue are coroutines or f…

7edbbaf

…unctions Add a check to see wheter callbacks are awaitable coroutines or functions, as coroutines need to be awaited. GH-4581

ref(worker): Amend return type of submit and flush to accomodate for …

0f63d24

…coroutines Coroutines do not return None, therefore it is necessary to consider this in the callback parameter of the worker. Previously, only callbacks with return Type None were accepted. GH-4581

ref(worker): Add type parameters for AsyncWorker variables

2430e2e

GH-4581

ref(worker): Remove loop upon killing worker

96fcd85

GH-4581

feat(worker): Enable concurrent callbacks on async task worker

331e40b

Enable concurrent callbacks on async task worker by firing them as a task rather than awaiting them. A done callback handles the necessary queue and exception logic. GH-4581

fix(worker): Modify kill behaviour to mirror threaded worker

5f67485

Changed kill to also use the _TERMINATOR sentinel, so the queue is still drained to this point on kill instead of cancelled immediately. This should also fix potential race conditions with flush_async. GH-4581

ref(worker): add proper type annotation to worker task list

97c5e3d

Add proper type annotation to worker task list to fix linting problems GH-4581

feat(transport): Add async transport class

8809b08

Add an implementation of Transport to work with the async background worker and HTTPCore async. GH-4582

ref(transport): Fix event loop handling in async transport

7c5dec0

Async Transport now properly checks for the presence of the event loop in capture_envelop, and drops items in case the event loop is no longer running for some reason. GH-4582

feat(transport): Add kill method for async transport

b0390e6

Implement a kill method that properly shuts down the async transport. The httpcore async connection pool needs to be explicitly shutdown at the end of its usage. GH-4582

ref(transport): Fix type errors in async transport

f01b00d

Fix type errors resulting from async override and missing type definition in the async transport. GH-4582

Add silent failing to kill on event loop errors

23b8ea2

Add a try/catch to ensure silent fail on kill in case the event loop shuts down. GH-4582

ref(transport): Fix event loop check in make_transport

176a1d1

Fix the event loop check in make_transport so that it does not throw a runtime error but rather falls back correctly. GH-4582

ref(transport): Add missing transport instantiation in non-async context

4fe61bf

GH-4582

ref(transport): Fix httpcore async specific request handling

52c9e36

GH-4582

fix(asyncio integration): Filter SDK internal tasks from asyncio spans

41983fc

Add a context manager to track internal task creation context. This can be used to track what tasks are created internally by the SDK GH-4699

srothh changed the base branch from master to potel-base August 13, 2025 15:12

srothh changed the base branch from potel-base to srothh/async-transport-integration August 13, 2025 15:13

srothh added 2 commits August 13, 2025 17:24

ref(asyncio integration): Change Context manager name

cfbea39

GH-4699

ref(asyncio integration): Update context var names

7c0d466

GH-4699

sl0thentr0py and others added 10 commits August 13, 2025 18:30

Merge remote-tracking branch 'origin/srothh/transport-class-hierarchy…

a2aafb4

…' into srothh/async-transport-integration

ref(asyncio integration): Refactor asyncio context filtering

31ae84b

GH-4699

ref(asyncio integration): Refactor code to avoid duplication

e170cf7

GH-4699

test(transport): Remove background tasks from transport tests

6dd8138

GH-4601

Merge branch 'srothh/async-transport-integration' into srothh/async-t…

7ae7f12

…ask-identifier

fix(transport): Add asyncio integration check to async transport

5f7af94

GH-4601

fix(transport): Fix asyncio integration check for transport

f44f690

GH-4601

Merge branch 'srothh/async-transport-integration' into srothh/async-t…

b1eff8b

…ask-identifier

fix(asyncio integration): Change loop scope for asyncio test

f4bc00a

GH-4699

ref(asyncio integrations): Fix asyncio tests

df1ceaf

GH-4699

sl0thentr0py approved these changes Aug 14, 2025

View reviewed changes

srothh marked this pull request as ready for review August 14, 2025 11:24

srothh requested a review from a team as a code owner August 14, 2025 11:24

This comment was marked as outdated.

Sign in to view

Base automatically changed from srothh/async-transport-integration to srothh/transport-class-hierarchy August 14, 2025 13:31

sl0thentr0py mentioned this pull request Aug 14, 2025

Add experimental async transport #4572

Open

Merge branch 'srothh/transport-class-hierarchy' into srothh/async-tas…

315f8dc

…k-identifier

This comment was marked as outdated.

Sign in to view

fix(asyncio integration): Fix wrong merge decision for test

e3bcf06

GH-4699

This comment was marked as outdated.

Sign in to view

ref(client): Remove wrong type annotation

cb67c24

GH-4699

sl0thentr0py approved these changes Aug 14, 2025

View reviewed changes

sl0thentr0py merged commit 371ca96 into srothh/transport-class-hierarchy Aug 14, 2025
122 of 125 checks passed

sl0thentr0py deleted the srothh/async-task-identifier branch August 14, 2025 14:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(asyncio integration): Filter SDK internal tasks from span creation #4700

fix(asyncio integration): Filter SDK internal tasks from span creation #4700

Uh oh!

srothh commented Aug 13, 2025 •

edited

Loading

Uh oh!

codecov bot commented Aug 13, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

fix(asyncio integration): Filter SDK internal tasks from span creation #4700

fix(asyncio integration): Filter SDK internal tasks from span creation #4700

Uh oh!

Conversation

srothh commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 17 Tests Failed:

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

srothh commented Aug 13, 2025 •

edited

Loading

codecov bot commented Aug 13, 2025 •

edited

Loading