Log4j 2.xSet 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.
Sentry can integrate with OpenTelemetry. You can find more information about it here.
First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:
- Setting a uniform sample rate for all transactions using the
tracesSampleRateoption in your SDK config to a number between0and1. (For example, to send 20% of transactions, settracesSampleRateto0.2.) - Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the
tracesSamplerconfig 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 performance monitoring options, how to use the tracesSampler function, or how to sample transactions.
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.
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").
- Package:
- maven:io.sentry:sentry-log4j2
- Version:
- 7.8.0
- Repository:
- https://github.com/getsentry/sentry-java
- API Documentation:
- https://javadoc.io/doc/io.sentry
