Skip to content

feat: Make transport channel capacity configurable#1040

Open
mvanhorn wants to merge 5 commits intogetsentry:masterfrom
mvanhorn:feat/configurable-transport-channel-capacity
Open

feat: Make transport channel capacity configurable#1040
mvanhorn wants to merge 5 commits intogetsentry:masterfrom
mvanhorn:feat/configurable-transport-channel-capacity

Conversation

@mvanhorn
Copy link
Copy Markdown

@mvanhorn mvanhorn commented Mar 27, 2026

Summary

Adds transport-level with_channel_capacity constructors so users can tune the bounded channel size used by the transport thread. The default remains 30, preserving existing behavior.

The original design added a transport_channel_capacity field to ClientOptions. Per @szokeasaurusrex's review, refactored to additive transport-level methods so ClientOptions stays minimal and the feature is opt-in at the transport boundary.

Why this matters

In high-throughput scenarios (many transactions with single spans each), the hardcoded capacity of 30 can saturate quickly, leading to dropped envelopes. Identified in #923, tracked in #994. Making it configurable lets users trade memory for reliability based on their workload.

Changes

  • sentry/src/transports/thread.rs: TransportThread::new(send) keeps its original signature. New TransportThread::with_capacity(send, channel_capacity) accepts a custom capacity, clamped to a minimum of 1 to avoid rendezvous channels.
  • sentry/src/transports/tokio_thread.rs: Same pattern for the async transport variant.
  • sentry/src/transports/curl.rs: Added CurlHttpTransport::with_channel_capacity(options, channel_capacity). new(options) unchanged.
  • sentry/src/transports/reqwest.rs: Added ReqwestHttpTransport::with_channel_capacity(options, channel_capacity). new(options) / with_client(options, client) unchanged.
  • sentry/src/transports/ureq.rs: Added UreqHttpTransport::with_channel_capacity(options, channel_capacity). new(options) / with_agent(options, agent) unchanged.

Usage

let opts = ClientOptions {
    transport: Some(Arc::new(move |opts| {
        Arc::new(ReqwestHttpTransport::with_channel_capacity(opts, 256))
    })),
    ..Default::default()
};

Testing

  • cargo check --workspace --all-features passes
  • cargo fmt --all clean
  • cargo clippy --workspace --all-features clean
  • Default behavior unchanged (capacity stays at 30 unless explicitly configured)

Closes #994

This contribution was developed with AI assistance (Claude Code).

Add `transport_channel_capacity` field to `ClientOptions` that controls
the bounded sync channel size used by the transport thread. Defaults to
30 (preserving current behavior). Users in high-throughput scenarios can
increase this to reduce the chance of dropped envelopes.

Closes getsentry#994

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment thread sentry-core/src/clientoptions.rs Outdated
Comment thread sentry/src/transports/thread.rs Outdated
Comment thread sentry-core/src/clientoptions.rs Outdated
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 13, 2026

Codecov Report

❌ Patch coverage is 3.70370% with 156 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.69%. Comparing base (a57b91c) to head (6f724ba).
⚠️ Report is 51 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1040      +/-   ##
==========================================
- Coverage   73.81%   73.69%   -0.12%     
==========================================
  Files          64       65       +1     
  Lines        7538     7577      +39     
==========================================
+ Hits         5564     5584      +20     
- Misses       1974     1993      +19     

@szokeasaurusrex
Copy link
Copy Markdown
Member

Hi @mvanhorn, thanks for the contribution! Before I proceed to a full review, please address the CI failures and the AI review agent comments. If any of the AI review comments are inaccurate, please comment on them and mark as resolved. Thanks!

- Add transport_channel_capacity to manual Debug implementation
- Clamp channel capacity to minimum of 1 to prevent rendezvous
  channel from silently dropping envelopes via try_send
- Run cargo fmt to fix lint CI failure
@mvanhorn
Copy link
Copy Markdown
Author

Addressed in 9c8f904:

  • Added transport_channel_capacity to the manual Debug impl
  • Clamped capacity to min 1 to prevent rendezvous channel (try_send would silently drop)
  • Ran cargo fmt

Copy link
Copy Markdown
Member

@szokeasaurusrex szokeasaurusrex left a comment

Choose a reason for hiding this comment

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

Thanks again for the contribution. I think we should revise the public API shape to avoid public API breakages before merging this change.

The current implementation introduces public API breakage by:

  • adding a new public field to ClientOptions
  • changing the signatures of the public transport thread constructors

I would like to avoid those breakages here and instead expose this as additive API:

  • add additive with_capacity(...) constructors on the public transport thread types, i.e. StdTransportThread::with_capacity(send, channel_capacity) and TokioTransportThread::with_capacity(send, channel_capacity)
  • keep the existing new(...) signatures unchanged, but make those constructors delegate to with_capacity(..., 30)
  • add transport-specific constructors such as ReqwestHttpTransport::with_channel_capacity(options, channel_capacity) (and similarly for curl and ureq), which would use those new with_capacity(...) thread constructors internally
  • document use through ClientOptions.transport

That still gives users a way to override the transport queue capacity via the existing TransportFactory mechanism, without changing ClientOptions yet.

For example, initializing the SDK with a custom capacity could look like this:

let opts = ClientOptions {
    transport: Some(Arc::new(move |opts| {
        Arc::new(ReqwestHttpTransport::with_channel_capacity(opts, 256))
    })),
    ..Default::default()
};

If you are open to it, please refactor the PR in that direction. If not, let me know and I can take it over as a follow-up.

…el_capacity

Per review: avoid public API breakages in ClientOptions and the transport
constructors. Replace the 'transport_channel_capacity: usize' field and the
changed TransportThread/transport constructor signatures with purely
additive APIs:

- TransportThread::new(send) restored to original signature, delegates to
  with_capacity(send, 30). TransportThread::with_capacity(send, capacity)
  is the new entry point for custom capacity.
- Same pattern for tokio_thread::TransportThread.
- ReqwestHttpTransport/CurlHttpTransport/UreqHttpTransport gain
  with_channel_capacity(options, capacity). Existing new/with_client/
  with_agent keep the default capacity of 30.
- Remove transport_channel_capacity from ClientOptions (field, Default,
  and Debug impl).

Users that need to override capacity configure it via
ClientOptions.transport with a factory returning the desired transport,
e.g. Arc::new(move |opts| Arc::new(ReqwestHttpTransport::with_channel_capacity(opts, 256))).
@mvanhorn
Copy link
Copy Markdown
Author

Thanks for the direction @szokeasaurusrex. Refactored to the additive shape you described in fbff3ea:

  • TransportThread::new(send) restored to the original signature. New TransportThread::with_capacity(send, channel_capacity) is the entry point for custom capacity (clamped to a minimum of 1 to avoid the rendezvous channel). Same pattern in tokio_thread::TransportThread.
  • ReqwestHttpTransport::with_channel_capacity(options, channel_capacity) added. new(options) / with_client(options, client) keep the default capacity of 30. Same for CurlHttpTransport and UreqHttpTransport (with_agent likewise unchanged).
  • Removed transport_channel_capacity from ClientOptions (field, Default, and the manual Debug impl).

Your example works unchanged:

let opts = ClientOptions {
    transport: Some(Arc::new(move |opts| {
        Arc::new(ReqwestHttpTransport::with_channel_capacity(opts, 256))
    })),
    ..Default::default()
};

cargo check --workspace --all-features, cargo fmt --all, and cargo clippy --workspace --all-features all pass.

Comment thread sentry/src/transports/curl.rs
Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit fbff3ea. Configure here.

Comment thread sentry/src/transports/reqwest.rs
@lcian lcian removed their request for review April 15, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make transport channel capacity configurable

2 participants