Java
Sentry's Java SDK enables capturing sessions for Release health as well as reporting messages and errors.
Sentry for Java is a collection of modules provided by Sentry; it supports Java 1.8 and above. At its core, Sentry for Java provides a raw client for sending events to Sentry. To begin, we highly recommend you use one of the logging libraries or framework integrations.
The Sentry Java SDK can be used with Kotlin, Scala, and other JVM languages. Code examples are typically provided in both Java and Kotlin.
On this page, we get you up and running with Sentry's SDK.
Using a framework?
Check out the other SDKs we support in the left-hand dropdown.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Sentry captures data by using an SDK within your application’s runtime.
build.gradleplugins {
id "io.sentry.jvm.gradle" version "5.0.0"
}
We recommend using our Gradle plugin as it can add integrations and provide source context for events.
If you are manually adding multiple Sentry dependencies, you can add a bill of materials to avoid specifying the version of each dependency.
When running your application, please add our sentry-opentelemetry-agent to the java command. You can download the latest version of the sentry-opentelemetry-agent-8.1.0.jar from MavenCentral. It's also available as a ZIP containing the JAR used on this page on GitHub.
SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent-8.1.0.jar -jar your-application.jar
Configuration should happen as early as possible in your application's lifecycle.
import io.sentry.Sentry;
Sentry.init(options -> {
options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
// Set traces_sample_rate to 1.0 to capture 100%
// of transactions for tracing.
// We recommend adjusting this value in production.
options.setTracesSampleRate(1.0);
});
The SDK can be configured using a sentry.properties file:
sentry.propertiesdsn=https://examplePublicKey@o0.ingest.sentry.io/0
traces-sample-rate=1.0
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
import io.sentry.Sentry;
try {
throw new Exception("This is a test.");
} catch (Exception e) {
Sentry.captureException(e);
}
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
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").