How to Integrate Sentry Java SDK with Spring Boot for Real‑Time Error Reporting

Sentry Java SDK Overview

Sentry is an open‑source real‑time error reporting tool that supports web front‑end, back‑end, mobile apps and games, and integrates with many languages and frameworks such as Python, Go, Node, Django, Ruby on Rails, and Java.

Basic Concepts

Each Sentry project has a unique PROJECT_ID together with a PUBLIC_KEY and SECRET_KEY used for authentication. These values form a DSN (Data Source Name) that identifies the project when sending events.

{PROTOCOL}://{PUBLICKEY}:{SECRETKEY}@{HOST}/{PATH}{PROJECT_ID}

Typical values: PROTOCOL is http or https, HOST is the Sentry server host, and PATH is usually empty.

Using the Sentry SDK in Spring Boot

In a Spring Boot project the Sentry SDK is provided by the raven‑logback library (also known as Raven). Add the dependency to pom.xml:

<!-- Import Sentry -->
<dependency>
    <groupId>com.getsentry.raven</groupId>
    <artifactId>raven-logback</artifactId>
    <version>8.0.2</version>
</dependency>

Then create a logback.xml configuration file. A minimal configuration that sends WARN‑level events to Sentry looks like this:

<configuration>
    <property name="Log_Home" value="mylogs/test"/>

    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="Sentry" class="com.getsentry.raven.logback.SentryAppender">
        <dsn>http://d73b23c481654b9ca0e4e8a9db310169:[email protected]/7</dsn>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
    </appender>

    <root level="INFO">
        <appender-ref ref="Console"/>
        <appender-ref ref="Sentry"/>
    </root>
</configuration>

Make sure the property logging.config=classpath:logback.xml is set in application.properties so Spring Boot picks up the custom configuration.

Application Usage

With the configuration in place, you can use a normal SLF4J logger in your controllers. For example:

@RequestMapping(value = "/testlog", method = RequestMethod.GET)
public void testLog() {
    logger.info("test接口"); // INFO will not be sent because the Sentry appender filters at WARN
    logger.error("error"); // ERROR will be sent to Sentry and trigger email notifications
}

Raven will automatically forward WARN and higher level logs to the Sentry server.

Using Sentry Web Service

Log in to the Sentry web UI to view captured events, configure alerts, and manage projects. (Details omitted for brevity.)

Appendix – Reference Configuration

The full logback.xml example includes separate appenders for DEBUG, INFO, WARN and ERROR levels, each with its own rolling file policy, pattern, and size limits. The configuration demonstrates how to combine console output, file rotation, and Sentry forwarding in a single logging setup.