Integrate async transport with SDK #4615

srothh · 2025-07-23T14:22:28Z

Integrate the async transport with the rest of the SDK. Provide a new experimental option transport_async that enables the async transport if an event loop is running. Otherwise, fall back to the sync transport.

Furthermore, adapt the client to work with the async transport. To this end, flush and close were changed to be non blocking and awaitable in an async context to avoid deadlocks, however close enforces a completed flush before shutdown. As there are to my knowledge no background threads running flush/close, these methods are currently not thread-safe/loop-aware for async, which can be changed if necessary.

Atexit issue: The atexit integration used by the SDK runs after the event loop has already closed if asyncio.run() is used. This makes it impossible for the async flush to happen, as atexit calls client.close(), but a loop is no longer present. I attempted to apply this fix by patching the loop close in the asyncio integration, but I am unsure if I did it correctly/put it in the correct spot. From my SDK test however, it seems to fix the flush issue. Note also that this will apparently be patched in Python 3.14, as per the discussion in the linked thread.

As a final note, I added event loop checking. Whenever the event loop is used, the transport/client catch RuntimeErrors, which would be thrown in case the event loop was already shut down. I am not sure if this is a case we need to consider, but I added it for now because I did not want the transport to potentially throw RuntimeError if the event loop is shutdown during a program. If this should be left out currently for simplicity, I can remove it again.

Do I also need to add the httpcore[asyncio] dependency to requirements-testing ?

GH-4601

codecov · 2025-07-23T14:26:01Z

❌ 54 Tests Failed:

Tests completed	Failed	Passed	Skipped
21089	54	21035	1098

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

tests.integrations.huggingface_hub.test_huggingface_hub::test_bad_chat_completion

Stack Traces | 0.1s run time

.../integrations/huggingface_hub/test_huggingface_hub.py:149: in test_bad_chat_completion
    client.text_generation(prompt="hello")
sentry_sdk/integrations/huggingface_hub.py:84: in new_text_generation
    raise e from None
sentry_sdk/integrations/huggingface_hub.py:80: in new_text_generation
    res = f(*args, **kwargs)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../huggingface_hub/inference/_client.py:2297: in text_generation
    request_parameters = provider_helper.prepare_request(
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/_common.py:93: in prepare_request
    provider_mapping_info = self._prepare_mapping_info(model)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:38: in _prepare_mapping_info
    _check_supported_task(model_id, self.task)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:187: in _check_supported_task
    raise ValueError(
E   ValueError: Model 'mistralai/Mistral-Nemo-Instruct-2407' doesn't support task 'text-generation'. Supported tasks: 'None', got: 'text-generation'

tests.integrations.huggingface_hub.test_huggingface_hub::test_streaming_chat_completion[True-True-True]

Stack Traces | 0.102s run time

.../integrations/huggingface_hub/test_huggingface_hub.py:112: in test_streaming_chat_completion
    client.text_generation(
sentry_sdk/integrations/huggingface_hub.py:84: in new_text_generation
    raise e from None
sentry_sdk/integrations/huggingface_hub.py:80: in new_text_generation
    res = f(*args, **kwargs)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../huggingface_hub/inference/_client.py:2297: in text_generation
    request_parameters = provider_helper.prepare_request(
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/_common.py:93: in prepare_request
    provider_mapping_info = self._prepare_mapping_info(model)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:38: in _prepare_mapping_info
    _check_supported_task(model_id, self.task)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:187: in _check_supported_task
    raise ValueError(
E   ValueError: Model 'mistralai/Mistral-Nemo-Instruct-2407' doesn't support task 'text-generation'. Supported tasks: 'None', got: 'text-generation'

tests.integrations.huggingface_hub.test_huggingface_hub::test_streaming_chat_completion[False-False-False]

Stack Traces | 0.105s run time

.../integrations/huggingface_hub/test_huggingface_hub.py:112: in test_streaming_chat_completion
    client.text_generation(
sentry_sdk/integrations/huggingface_hub.py:84: in new_text_generation
    raise e from None
sentry_sdk/integrations/huggingface_hub.py:80: in new_text_generation
    res = f(*args, **kwargs)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../huggingface_hub/inference/_client.py:2297: in text_generation
    request_parameters = provider_helper.prepare_request(
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/_common.py:93: in prepare_request
    provider_mapping_info = self._prepare_mapping_info(model)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:38: in _prepare_mapping_info
    _check_supported_task(model_id, self.task)
.tox/py3.8-huggingface_hub-v0.33.4/lib/python3.8.../inference/_providers/hf_inference.py:187: in _check_supported_task
    raise ValueError(
E   ValueError: Model 'mistralai/Mistral-Nemo-Instruct-2407' doesn't support task 'text-generation'. Supported tasks: 'None', got: 'text-generation'

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

Add a new experimental option that uses AsyncHttpTransport and integrates it with synchronous client interfaces. GH-4601

Fix type issues in the Async Transport. GH-4601

GH-4601

Add event loop checks to client flush/close in async, in order to ensure silent failing instead of runtime error propagation/crashing. GH-4601

Moved the logic of the done callback directly into the async task to provide a cleaner and simpler control flow. GH-4601

GH-4601

cursor

Bug: Async Context Manager Fails to Await Cleanup

When using AsyncHttpTransport, the synchronous __exit__ method calls self.close() but does not await the returned asyncio.Task. This prevents proper asynchronous cleanup (e.g., flushing events, closing transport) when the client is used as a context manager, potentially leading to lost events or resource leaks.

sentry_sdk/client.py#L1011-L1013

sentry-python/sentry_sdk/client.py

Lines 1011 to 1013 in 425abaf

    
           def __exit__(self, exc_type: Any, exc_value: Any, tb: Any) -> None: 
        
               self.close()

Fix in Cursor • Fix in Web

sentry_sdk/client.py

Gh-4601

cursor

Bug: Async Cleanup Fails in Sync Context

The __exit__ method calls self.close() but does not await the asyncio.Task returned when AsyncHttpTransport is used. Since __exit__ is synchronous, this prevents the async flush and cleanup operations from completing, leading to potential data loss or resource leaks when the client is used as a context manager.

sentry_sdk/client.py#L1011-L1014

sentry-python/sentry_sdk/client.py

Lines 1011 to 1014 in 6bdc1ff

    
           def __exit__(self, exc_type: Any, exc_value: Any, tb: Any) -> None: 
        
               self.close()

Fix in Cursor • Fix in Web

sentry_sdk/client.py

GH-4601

cursor · 2025-07-25T10:32:18Z

sentry_sdk/client.py


            if self.log_batcher is not None:
                self.log_batcher.flush()

-            self.transport.flush(timeout=timeout, callback=callback)
+                self.transport.flush(timeout=timeout, callback=callback)


Bug: Transport Flush Fails When Log Batcher Absent

In the synchronous transport path of the Client.flush method, the self.transport.flush() call is incorrectly indented. It is nested inside the if self.log_batcher is not None: block, preventing the transport from flushing when log_batcher is None. This can lead to event loss, as the transport should always be flushed regardless of log_batcher's presence.

Locations (1)

sentry_sdk/client.py#L987-L994

Fix in Cursor • Fix in Web

GH-4601

cursor

Bug: Async Transport Cleanup Fails in Sync Context

The __exit__ method calls self.close() but does not await the asyncio.Task returned when AsyncHttpTransport is in use. As __exit__ is synchronous, it cannot await this task, preventing proper flushing and cleanup of async transport resources when the client is used as a context manager. This leads to incomplete shutdown and potential loss of events.

sentry_sdk/client.py#L1011-L1013

sentry-python/sentry_sdk/client.py

Lines 1011 to 1013 in 67afe4d

    
           def __exit__(self, exc_type: Any, exc_value: Any, tb: Any) -> None: 
        
               self.close()

Fix in Cursor • Fix in Web

cursor · 2025-07-25T10:37:15Z

sentry_sdk/integrations/asyncio.py

+            loop.close = _patched_close  # type: ignore
+            loop._sentry_flush_patched = True  # type: ignore
+
+        _patch_loop_close()


Bug: Asyncio Loop Shutdown Issues

The _patch_loop_close() function, intended to flush pending events before asyncio loop shutdown, has two issues. First, it often fails to patch the event loop because asyncio.get_running_loop() raises a RuntimeError when called during SDK initialization (before an event loop is running), preventing the patch from being applied in common scenarios. Second, even if patched, the _patched_close function calls loop.run_until_complete(_flush()) from within loop.close(). This is problematic as run_until_complete() expects a non-running loop, while loop.close() may be in an intermediate shutdown state, potentially leading to deadlocks, exceptions, or an inconsistent loop state. Additionally, _flush() creates new tasks on a shutting-down loop, which may not execute reliably.

Locations (1)

sentry_sdk/integrations/asyncio.py#L128-L170

Fix in Cursor • Fix in Web

First issue: If init is called outside of an event loop, the transport falls back to the synchronous version anyway, so this should not be a problem.

Second issue: This is the same way the python discussion thread as well as asyncio-atexit handle it, so it seems to be the standard way of circumventing this issue. From my quick manual test, it also did not lead to problems.

srothh · 2025-07-25T10:53:28Z

Bug: Async Cleanup Fails in Sync Context

The __exit__ method calls self.close() but does not await the asyncio.Task returned when AsyncHttpTransport is used. Since __exit__ is synchronous, this prevents the async flush and cleanup operations from completing, leading to potential data loss or resource leaks when the client is used as a context manager.

sentry_sdk/client.py#L1011-L1014
Fix in Cursor • Fix in Web

I think this is not a problem. If this should work, I think it would need to implement a seperate async context manager.

srothh force-pushed the srothh/async-transport-integration branch from e5ea8e9 to 57ea658 Compare July 24, 2025 07:47

srothh marked this pull request as ready for review July 24, 2025 07:58

srothh requested a review from a team as a code owner July 24, 2025 07:58

srothh force-pushed the srothh/async-transport-integration branch 2 times, most recently from caedf99 to effb1a0 Compare July 24, 2025 09:50

srothh added 11 commits July 25, 2025 11:22

Integrate AsyncHttpTransport as a new experimental option

a74c178

Add a new experimental option that uses AsyncHttpTransport and integrates it with synchronous client interfaces. GH-4601

ref(transport): Fix type issues in AsyncTransport

c990da6

Fix type issues in the Async Transport. GH-4601

ref(transport): Add missing async transport loop type annotation

c597f30

GH-4601

fix(client): Fix mypy type errors

35542dc

GH-4601

ref(client): Fix mypy inheritance type error

b424e1d

GH-4601

ref(client): Move mypy annotations to correct place

8e943b2

GH-4601

ref(client): Add event loop handling to client flush/close

892f064

Add event loop checks to client flush/close in async, in order to ensure silent failing instead of runtime error propagation/crashing. GH-4601

ref(client): Moved close done callback into async task

753908a

Moved the logic of the done callback directly into the async task to provide a cleaner and simpler control flow. GH-4601

ref(transport): fix wrong loop variable name in async transport

a678e51

GH-4601

ref(client): Move timeout check in client to properly cover async

89d00cd

GH-4601

feat(asyncio): Add patching for loop.close in asyncio

425abaf

GH-4601

srothh force-pushed the srothh/async-transport-integration branch from effb1a0 to 425abaf Compare July 25, 2025 10:08

cursor bot reviewed Jul 25, 2025

View reviewed changes

sentry_sdk/client.py Show resolved Hide resolved

ref(asyncio): Fix mypy type annotation errors

6bdc1ff

Gh-4601

cursor bot reviewed Jul 25, 2025

View reviewed changes

sentry_sdk/client.py Show resolved Hide resolved

ref(client): Fix redundant async flush helper flushes

3540464

GH-4601

cursor bot reviewed Jul 25, 2025

View reviewed changes

ref(client): remove wrongful indent

67afe4d

GH-4601

cursor bot reviewed Jul 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Integrate async transport with SDK #4615

Integrate async transport with SDK #4615

srothh commented Jul 23, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jul 23, 2025 •

edited

Loading

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

cursor bot Jul 25, 2025

Uh oh!

srothh Jul 25, 2025

Uh oh!

cursor bot left a comment

Uh oh!

cursor bot Jul 25, 2025

Uh oh!

srothh Jul 25, 2025

Uh oh!

srothh commented Jul 25, 2025

Bug: Async Cleanup Fails in Sync Context

Uh oh!

Uh oh!


	def __exit__(self, exc_type: Any, exc_value: Any, tb: Any) -> None:
	self.close()

Integrate async transport with SDK #4615

Are you sure you want to change the base?

Integrate async transport with SDK #4615

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

❌ 54 Tests Failed:

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Async Context Manager Fails to Await Cleanup

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Async Cleanup Fails in Sync Context

Uh oh!

Uh oh!

cursor bot Jul 25, 2025

Choose a reason for hiding this comment

Bug: Transport Flush Fails When Log Batcher Absent

Uh oh!

srothh Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Async Transport Cleanup Fails in Sync Context

Uh oh!

cursor bot Jul 25, 2025

Choose a reason for hiding this comment

Bug: Asyncio Loop Shutdown Issues

Uh oh!

srothh Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

srothh commented Jul 25, 2025

Bug: Async Cleanup Fails in Sync Context

Uh oh!

Uh oh!

srothh commented Jul 23, 2025 •

edited

Loading

codecov bot commented Jul 23, 2025 •

edited

Loading