Skip to content

Commit cfa0c39

Browse files
committed
document java backpressure option
1 parent 4e574d5 commit cfa0c39

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/platforms/java/common/configuration/options.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,14 @@ _(New in version 6.0.0)_
162162

163163
</ConfigKey>
164164

165+
<ConfigKey name="enable-backpressure-handling">
166+
167+
Set this boolean to `true` to enable automatic downsampling of transactions while the system is under load. The `tracesSampleRate` is halved for every failing health check up to 10 times, roughly meaning 0.001% of the original `tracesSampleRate`. Any positive health check will reset `tracesSampleRate` to its original value. Health checks are happening in the background every 10 seconds and check for queue drops as well as rate limiting.
168+
169+
_(New in version 7.1.0)_
170+
171+
</ConfigKey>
172+
165173
## Integration Configuration
166174

167175
For many platform SDKs integrations can be configured alongside it. On some platforms that happen as part of the `init()` call, in some others, different patterns apply.

docs/platforms/java/common/configuration/sampling.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ We recommend sampling your transactions for two reasons:
2929

3030
Choose a sampling rate with the goal of finding a balance between performance and volume concerns with data accuracy. You don't want to collect _too_ much data, but you want to collect sufficient data from which to draw meaningful conclusions. If you’re not sure what rate to choose, start with a low value and gradually increase it as you learn more about your traffic patterns and volume.
3131

32+
If you would like Sentry to automatically downsample while the system is under load, take a look at <PlatformLink to="/configuration/options/#enable-backpressure-handling"><PlatformIdentifier name="enable-backpressure-handling" /></PlatformLink>.
33+
3234
## Configuring the Transaction Sample Rate
3335

3436
The Sentry SDKs have two configuration options to control the volume of transactions sent to Sentry, allowing you to take a representative sample:

0 commit comments

Comments
 (0)