Spring Boot

On this page, we get you up and running with Sentry's SDK.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Install

Sentry captures data by using an SDK within your application’s runtime.

plugins {
  id "io.sentry.jvm.gradle" version "5.12.1"
}

curl https://repo1.maven.org/maven2/io/sentry/sentry-opentelemetry-agent/8.23.0/sentry-opentelemetry-agent-8.23.0.jar -o sentry-opentelemetry-agent-8.23.0.jar

SENTRY_AUTO_INIT=false JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-8.23.0.jar" java -jar your-application.jar

Configure

Sentry's Spring Boot integration auto-configures sentry.in-app-packages property with the package where @SpringBootApplication or @SpringBootConfiguration annotated class is located.

Provide a sentry.dsn property using either application.properties or application.yml:

sentry.dsn=https://examplePublicKey@o0.ingest.sentry.io/0
example-org / example-project

# Add data like request headers and IP for users,
# see https://docs.sentry.io/platforms/java/guides/spring-boot/data-management/data-collected/ for more info
sentry.send-default-pii=true
#  performance

# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
# We recommend adjusting this value in production.
sentry.traces-sample-rate=1.0
#  performance

By default, only unhandled exceptions are sent to Sentry. This behavior can be tuned through configuring the sentry.exception-resolver-order property. For example, setting it to -2147483647 (the value of org.springframework.core.Ordered#HIGHEST_PRECEDENCE) ensures exceptions that have been handled by exception resolvers with higher order are sent to Sentry - including ones handled by @ExceptionHandler annotated methods.

sentry.exception-resolver-order=-2147483647

We recommend using Sentry's Spring Boot integration with one of the logging framework integrations as they work together seamlessly. To use Sentry without Spring Boot, we recommend using the Sentry Spring integration.

Once this integration is configured you can also use Sentry’s static API, as shown on the usage page, to record breadcrumbs, set the current user, or manually send events, for example.

Verify

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);
}

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.