Set Up Tracing

Learn how to enable tracing in your app and discover valuable performance insights of your application.

With tracing, 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 Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.

Tracing is available for the Sentry Java SDK version ≥ 4.0.

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

  • Setting a uniform sample rate for all transactions using the tracesSampleRate option in your SDK config to a number between 0 and 1. (For example, to send 20% of transactions, set tracesSampleRate 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 tracesSampler config option.

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

If you are using either our Spring or Spring Boot integrations, errors are linked with spans automatically.

import io.sentry.Sentry;

Sentry.init(options -> {

+   // 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 tracing options, how to use the tracesSampler function, or how to sample transactions.

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.

While you're testing, set tracesSampleRate 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 tracesSampleRate value, or switch to using tracesSampler 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").