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.

Or alternatively:

Configure sample rate in or application.yml file:

# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
# We recommend adjusting this value in production.

Or through providing a bean of type SentryOptions#TracesSamplerCallback:

import io.sentry.SentryOptions.TracesSamplerCallback;
import io.sentry.SamplingContext;
import org.springframework.stereotype.Component;

class CustomTracesSamplerCallback implements TracesSamplerCallback {
  public Double sample(SamplingContext context) {
    CustomSamplingContext customSamplingContext = context.getCustomSamplingContext();
    if (customSamplingContext != null) {
      HttpServletRequest request = (HttpServletRequest) customSamplingContext.get("request");
      // return a number between 0 and 1 or null (to fallback to configured value)
    } else {
      // return a number between 0 and 1 or null (to fallback to configured value)

Without sampling, automatically-captured transactions can add up quickly. The Spring Boot integration, for example, will send a transaction for every request made to the server.

Learn more about tracing options, how to use the tracesSampler function, or how to sample transactions.

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

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