Set Up Performance

Learn how to enable performance monitoring in your app if it is not already set up.

With performance monitoring, Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in Distributed Tracing.

If you’re adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.

First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:

  • Setting a uniform sample rate for all transactions using the traces_sample_rate option in your SDK config to a number between 0 and 1. (For example, to send 20% of transactions, set traces_sample_rate to 0.2.)
  • Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the traces_sampler config option.

The two options are meant to be mutually exclusive. If you set both, traces_sampler will take precedence.

Copied
let _sentry = sentry::init(sentry::ClientOptions {
    release: sentry::release_name!(),
    // To set a uniform sample rate
    traces_sample_rate: 0.2,
    // The Rust SDK does not currently support `traces_sampler`

    ..Default::default()
});

Learn more about performance monitoring options, or how to sample transactions.

Verify that performance monitoring is working correctly by using our automatic instrumentation or by starting and finishing a transaction using custom instrumentation.

While you're testing, set traces_sample_rate to 1.0, as that ensures that every transaction will be sent to Sentry.

Once testing is complete, you may want to set a lower traces_sample_rate value, or switch to using traces_sampler to selectively sample and filter your transactions, based on contextual data.

Help improve this content
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").