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.

Configure the Sample Rate

Once you configure the sample rate, tracing will be enabled in your app. Set the sample rate for your transactions by either:

  1. 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.)
  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.

Performance Monitoring is available for the Sentry Java SDK version ≥ 4.0.

Copied
import io.sentry.Sentry;

Sentry.init(options -> {
  options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
  // To set a uniform sample rate
  options.setTracesSampleRate(1.0);
  // OR if you prefer, determine traces sample rate based on the sampling context
  options.setTracesSampler(
      context -> {
        // return a number between 0 and 1 or null (to fallback to configured value)
      });
});

Learn more about how the options work in Sampling Transactions.

Verify

Test out tracing by starting and finishing a transaction, which you must do so transactions can be sent to Sentry. Learn how in our Custom Instrumentation content.

Verify that performance monitoring is working correctly by setting traces-sample-rate to 1.0 as that ensures that every transaction will be sent to Sentry.

Once testing is complete, we recommend lowering this value in production by either lowering your traces-sample-rate value, or switching to using traces-sampler to dynamically sample and filter your transactions.

Next Steps:

You can edit this page on GitHub.