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.

Or alternatively:

Configure sample rate in application.properties or application.yml file:

Copied
sentry.traces-sample-rate=0.3

Or through providing a bean of type SentryOptions#TracesSamplerCallback:

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

@Component
class CustomTracesSamplerCallback implements TracesSamplerCallback {
  @Override
  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 how the options work in Sampling Transactions.

Verify

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, 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.

Connecting Services

If you are also using Performance Monitoring for JavaScript, depending on where your request originates, you can connect traces:

  1. For requests that start in your backend, by adding a meta tag in your HTML template that contains tracing information.
  2. For requests that start in JavaScript, by the SDK setting a header on requests to your backend.

Otherwise, backend services with Performance Monitoring connect automatically.

Next Steps:

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").