Sampling
Learn how to configure the volume of error and transaction events sent to Sentry.
Adding Sentry to your app gives you a great deal of very valuable information about errors and performance you wouldn't otherwise get. And lots of information is good -- as long as it's the right information, at a reasonable volume.
To send a representative sample of your errors to Sentry, set the sample_rate
option in your SDK configuration to a number between 0
(0% of errors sent) and 1
(100% of errors sent). This is a static rate, which will apply equally to all errors. For example, to sample 25% of your errors:
let _sentry = sentry::init(sentry::ClientOptions {
sample_rate: 1.0,
..Default::default()
});
The error sample rate defaults to 1
, meaning all errors are sent to Sentry.
Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs.
We recommend sampling your transactions for two reasons:
- Capturing a single trace involves minimal overhead, but capturing traces for every page load or every API request may add an undesirable load to your system.
- Enabling sampling allows you to better manage the number of events sent to Sentry, so you can tailor your volume to your organization's needs.
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.
The Sentry SDKs have two configuration options to control the volume of transactions sent to Sentry, allowing you to take a representative sample:
Uniform sample rate (
traces_sample_rate
):- Provides an even cross-section of transactions, no matter where in your app or under what circumstances they occur.
- Uses default inheritance and precedence behavior
Sampling function (
traces_sampler
) which:- Samples different transactions at different rates
- Filters out some transactions entirely
- Modifies default precedence and inheritance behavior
By default, none of these options are set, meaning no transactions will be sent to Sentry. You must set either one of the options to start sending transactions.
Sampling functions (traces_sampler
) are currently not supported by this platform.
To do this, set the traces_sample_rate
option in your sentry::init()
to a number between 0 and 1. With this option set, every transaction created will have that percentage chance of being sent to Sentry. For example, if you set traces_sample_rate
to 0.2
, approximately 20% of your transactions will be recorded and sent. That looks like this:
let _sentry = sentry::init(sentry::ClientOptions {
release: sentry::release_name!(),
traces_sample_rate: 1.0,
..Default::default()
});
Whatever a transaction's sampling decision, that decision will be passed to its child spans and from there to any transactions they subsequently cause in other services.
(See Distributed Tracing for more about how that propagation is done.)
If the transaction currently being created is one of those subsequent transactions (in other words, if it has a parent transaction), the upstream (parent) sampling decision will be included in the sampling context data. Your traces_sampler
can use this information to choose whether to inherit that decision. In most cases, inheritance is the right choice, to avoid breaking distributed traces. A broken trace will not include all your services.
If you're using a traces_sample_rate
rather than a traces_sampler
, the decision will always be inherited.
There are multiple ways for a transaction to end up with a sampling decision.
- Random sampling according to a static sample rate set in
traces_sample_rate
- Random sampling according to a sample function rate returned by
traces_sampler
- Absolute decision (100% chance or 0% chance) returned by
traces_sampler
- If the transaction has a parent, inheriting its parent's sampling decision
- Absolute decision passed to
start_transaction
When there's the potential for more than one of these to come into play, the following precedence rules apply:
- If a sampling decision is passed to
start_transaction
, that decision will be used, overriding everything else. - If
traces_sampler
is defined, its decision will be used. It can choose to keep or ignore any parent sampling decision, use the sampling context data to make its own decision, or choose a sample rate for the transaction. We advise against overriding the parent sampling decision because it will break distributed traces) - If
traces_sampler
is not defined, but there's a parent sampling decision, the parent sampling decision will be used. - If
traces_sampler
is not defined and there's no parent sampling decision,traces_sample_rate
will be used.
Forcing a sampling decision by passing it into start_transaction
is currently not supported by this platform.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").