Set Up Performance
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.
Configure the Sample Rate
Sampling for transactions must also be configured before
- Setting a uniform sample rate for all transactions using the
tracesSampleRate
option in your SDK config to a number between0
and1
. (For example, to send 20% of transactions, settracesSampleRate
to0.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.
Performance Monitoring is available for the Sentry Java SDK version ≥ 4.0.
If you are using either our Spring or Spring Boot integrations, errors are linked with spans automatically.
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
While you're testing, set tracesSampleRate
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 tracesSampleRate
value, or switching to using tracesSampler
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:
- For requests that start in your backend, by adding a meta tag in your HTML template that contains tracingThe process of logging the events that took place during a request, often across multiple services.information.
- 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:
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").
- Package:
- maven:io.sentry:sentry
- Version:
- 6.16.0
- Repository:
- https://github.com/getsentry/sentry-java