Add async transport #4614

srothh · 2025-07-23T13:31:31Z

Add async implementation of the abstract Transport class. This transport utilizes the async task worker as well as the httpcore async functionality.

Thread Safety: As capture_envelope is registered by the client as a callback for several background threads in the sdk, which are not running the event loop, capture_envelope in the transport is made to be thread safe and allow for execution on the event loop from other threads. The same is currently not the case for flush, as there does not seem to be a usage from background threads, however if necessary, it can also be added.

HTTP2 support: Currently not activated, but from the looks of the httpcore docs it should be as simple as setting the http2 in the init of the pool to true. This likely makes sense to support, as HTTP2 shows great performance improvements with concurrent requests.

Kill: The kill method is sync, but the pool needs to be closed asynchronously. Currently, this is done by launching a task. However, the task cannot be awaited in sync code without deadlocking, therefore kill followed by an immediate loop shutdown could technically lead to resource leakage. Therefore, I decided to make kill optionally return the async task, so it can be awaited if called from an async context.

Note also that parts of the code are very similar to the HTTP2 integration, as they both use the httpcore library. Maybe in a later PR there could be a shared superclass to avoid code duplication?

GH-4582

codecov · 2025-07-23T13:35:13Z

Codecov Report

❌ Patch coverage is 19.58042% with 115 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.86%. Comparing base (d2e647b) to head (295a0e9).
⚠️ Report is 1 commits behind head on srothh/async-task-worker.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
sentry_sdk/transport.py	19.58%	113 Missing and 2 partials ⚠️

Additional details and impacted files

@@                     Coverage Diff                      @@
##           srothh/async-task-worker    #4614      +/-   ##
============================================================
- Coverage                     84.51%   83.86%   -0.65%     
============================================================
  Files                           158      158              
  Lines                         15519    15657     +138     
  Branches                       2449     2473      +24     
============================================================
+ Hits                          13116    13131      +15     
- Misses                         1649     1769     +120     
- Partials                        754      757       +3

Files with missing lines	Coverage Δ
sentry_sdk/transport.py	`67.19% <19.58%> (-18.95%)`	⬇️

... and 3 files with indirect coverage changes

antonpirker

nice work. some nitpicking, a question and a change suggestion

sentry_sdk/transport.py

antonpirker · 2025-07-31T09:18:53Z

sentry_sdk/transport.py

+                },
+            )
+
+        def _flush_client_reports(self: Self, force: bool = False) -> None:


are there plans to make this async in the future?

I left it sync currently because it itself does not have an async component. But making it async would allow the entire request path to be async without changing functionality (and might also make it so the worker only needs to handle async callbacks), so it makes sense I think to make it an async function

Changed this to be an async coroutine; this also meant that I could go back to the worker and simplify the callbacks to only handle async without breaking it !

sentry_sdk/transport.py

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

Make kill optionally return a task for async transport. This allows for a blocking kill operation if the caller is in an async context. GH-4582

GH-4582

sentry_sdk/transport.py

srothh · 2025-07-31T12:23:26Z

The lint error is in an unrelated file, not sure why it is happening

antonpirker

Looks good now! (the linting just fails because openfeature released something yesterday that breaks our linting. ignore this)

srothh force-pushed the srothh/async-task-worker branch from 1a129f7 to 97c5e3d Compare July 23, 2025 14:04

srothh force-pushed the srothh/async-transport branch from 373942e to f01b00d Compare July 23, 2025 14:05

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

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

This comment was marked as outdated.

Sign in to view

srothh force-pushed the srothh/async-task-worker branch from 97c5e3d to b5eda0e Compare July 30, 2025 12:07

srothh force-pushed the srothh/async-transport branch from c541bd7 to f5ef707 Compare July 30, 2025 13:12

This comment was marked as outdated.

Sign in to view

srothh force-pushed the srothh/async-transport branch from fca8740 to 328d8ad Compare July 30, 2025 14:08

This comment was marked as outdated.

Sign in to view

antonpirker requested changes Jul 31, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

srothh added 10 commits July 31, 2025 14:10

feat(transport): Add async transport class

4a58ce7

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

cbecde7

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

c8bb55a

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

05a7de7

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

38246d0

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

8b226cb

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

823215e

GH-4582

ref(transport): Fix httpcore async specific request handling

4eed4fd

GH-4582

ref(transport): Add gc safety to async kill

afd494d

GH-4582

ref(transport): Add missing httpcore extensions

fcc7ac3

GH-4582

srothh added 9 commits July 31, 2025 14:10

fix(transport): Fix fallback sync transport creating async worker

f659514

GH-4582

ref(transport): Make kill optionally return a task for async

8c542ce

Make kill optionally return a task for async transport. This allows for a blocking kill operation if the caller is in an async context. GH-4582

ref(transport): Adapt transport for synchronous flush interface

30dde67

GH-4582

ref(transport): Fix mypy error

3392e0e

GH-4582

ref(transport): Make transport loop public

6c85500

GH-4582

ref(transport): Add import checking for async transport

ae5a864

GH-4582

ref(transport): Fix typing errors

9c537e6

GH-4582

ref(transport): Fix import checking

f7554b2

GH-4582

ref(transport): Refactor async transport to be more aligned with sync

6cb72ad

GH-4582

srothh force-pushed the srothh/async-transport branch from 295a0e9 to 6cb72ad Compare July 31, 2025 12:11

cursor bot reviewed Jul 31, 2025

View reviewed changes

sentry_sdk/transport.py Show resolved Hide resolved

antonpirker approved these changes Jul 31, 2025

View reviewed changes

srothh mentioned this pull request Jul 31, 2025

Complete Async Transport implementation #4654

Draft

Add async transport #4614

Are you sure you want to change the base?

Add async transport #4614

Uh oh!

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!

Codecov Report

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!

This comment was marked as outdated.

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!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

antonpirker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

antonpirker Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

srothh Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

srothh Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

srothh commented Jul 31, 2025

Uh oh!

antonpirker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

srothh commented Jul 23, 2025 •

edited

Loading

codecov bot commented Jul 23, 2025 •

edited

Loading