Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Java Backpressure Option #9539

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Document Java Backpressure Option #9539

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cfa0c39
document java backpressure option
adinauer Mar 22, 2024
f94eda6
disable instead of enable
adinauer Mar 22, 2024
6e98ce4
Apply suggestions from code review
adinauer Mar 25, 2024
f69ddc2
address pr review feedback
adinauer Jun 5, 2024
6157a24
Update docs/platforms/java/common/configuration/options.mdx
adinauer Nov 27, 2024
d750f1e
Merge branch 'master' into feat/java-backpressure-option
adinauer Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/platforms/java/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,14 @@ _(New in version 6.0.0)_

</ConfigKey>

<ConfigKey name="enable-backpressure-handling">

Set this boolean to `false` to disable automatic downsampling of transactions while the system is under load. The `tracesSampleRate` is halved for every failing health check up to 10 times, (roughly 0.001% of the original `tracesSampleRate`). Any positive health check will reset `tracesSampleRate` to its original value. Health checks run in the background every 10 seconds, checking for queue drops and rate limiting. Note: Before version 7.8.0 backpressure handling was disabled by default.
adinauer marked this conversation as resolved.
Show resolved Hide resolved

_(New in version 7.1.0)_
adinauer marked this conversation as resolved.
Show resolved Hide resolved

</ConfigKey>

## Integration Configuration

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.
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/java/common/configuration/sampling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ We recommend sampling your transactions for two reasons:

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.

As of version 7.8.0 of the Java SDK Sentry will 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> for more details or if you would like to opt out of this behaviour.

## Configuring the Transaction Sample Rate

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