Skip to content

Allow configuration of Sentry Logs for Spring Boot Logback #4508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@
<minimumLevel>INFO</minimumLevel>
</appender>
```
- For Spring Boot you may also enable it in `application.properties` / `application.yml`:
```properties
sentry.logs.enabled=true
sentry.logging.minimum-level=error
```
- If you manually initialize Sentry, you may also enable logs on `Sentry.init`:
```java
Sentry.init(options -> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,13 @@ public class io/sentry/spring/boot/jakarta/SentryProperties$Logging {
public fun getLoggers ()Ljava/util/List;
public fun getMinimumBreadcrumbLevel ()Lorg/slf4j/event/Level;
public fun getMinimumEventLevel ()Lorg/slf4j/event/Level;
public fun getMinimumLevel ()Lorg/slf4j/event/Level;
public fun isEnabled ()Z
public fun setEnabled (Z)V
public fun setLoggers (Ljava/util/List;)V
public fun setMinimumBreadcrumbLevel (Lorg/slf4j/event/Level;)V
public fun setMinimumEventLevel (Lorg/slf4j/event/Level;)V
public fun setMinimumLevel (Lorg/slf4j/event/Level;)V
}

public class io/sentry/spring/boot/jakarta/SentryProperties$Reactive {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ public void onApplicationEvent(final @NotNull ApplicationEvent event) {
Optional.ofNullable(sentryProperties.getLogging().getMinimumEventLevel())
.map(slf4jLevel -> Level.toLevel(slf4jLevel.name()))
.ifPresent(sentryAppender::setMinimumEventLevel);
Optional.ofNullable(sentryProperties.getLogging().getMinimumLevel())
.map(slf4jLevel -> Level.toLevel(slf4jLevel.name()))
.ifPresent(sentryAppender::setMinimumLevel);

sentryAppender.start();
logger.addAppender(sentryAppender);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,15 @@ public static class Logging {
/** Enable/Disable logging auto-configuration. */
private boolean enabled = true;

/** Minimum logging level for recording breadcrumb. */
/** Minimum logging level for recording breadcrumbs. */
private @Nullable Level minimumBreadcrumbLevel;

/** Minimum logging level for recording event. */
/** Minimum logging level for recording events. */
private @Nullable Level minimumEventLevel;

/** Minimum logging level for recording log events. */
private @Nullable Level minimumLevel;

/** List of loggers the SentryAppender should be added to. */
private @NotNull List<String> loggers = Arrays.asList(org.slf4j.Logger.ROOT_LOGGER_NAME);

Expand Down Expand Up @@ -162,6 +165,14 @@ public void setMinimumEventLevel(@Nullable Level minimumEventLevel) {
this.minimumEventLevel = minimumEventLevel;
}

public @Nullable Level getMinimumLevel() {
return minimumLevel;
}

public void setMinimumLevel(@Nullable Level minimumLevel) {
this.minimumLevel = minimumLevel;
}

@NotNull
public List<String> getLoggers() {
return loggers;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class SentryLogbackAppenderAutoConfigurationTest {
"sentry.dsn=http://key@localhost/proj",
"sentry.logging.minimum-event-level=info",
"sentry.logging.minimum-breadcrumb-level=debug",
"sentry.logging.minimum-level=error",
)
.run {
val appenders = rootLogger.getAppenders(SentryAppender::class.java)
Expand All @@ -92,6 +93,7 @@ class SentryLogbackAppenderAutoConfigurationTest {

assertThat(sentryAppender.minimumBreadcrumbLevel).isEqualTo(Level.DEBUG)
assertThat(sentryAppender.minimumEventLevel).isEqualTo(Level.INFO)
assertThat(sentryAppender.minimumLevel).isEqualTo(Level.ERROR)
}
}

Expand Down
2 changes: 2 additions & 0 deletions sentry-spring-boot/api/sentry-spring-boot.api
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,13 @@ public class io/sentry/spring/boot/SentryProperties$Logging {
public fun getLoggers ()Ljava/util/List;
public fun getMinimumBreadcrumbLevel ()Lorg/slf4j/event/Level;
public fun getMinimumEventLevel ()Lorg/slf4j/event/Level;
public fun getMinimumLevel ()Lorg/slf4j/event/Level;
public fun isEnabled ()Z
public fun setEnabled (Z)V
public fun setLoggers (Ljava/util/List;)V
public fun setMinimumBreadcrumbLevel (Lorg/slf4j/event/Level;)V
public fun setMinimumEventLevel (Lorg/slf4j/event/Level;)V
public fun setMinimumLevel (Lorg/slf4j/event/Level;)V
}

public class io/sentry/spring/boot/SentryWebfluxAutoConfiguration {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ public void onApplicationEvent(final @NotNull ApplicationEvent event) {
Optional.ofNullable(sentryProperties.getLogging().getMinimumEventLevel())
.map(slf4jLevel -> Level.toLevel(slf4jLevel.name()))
.ifPresent(sentryAppender::setMinimumEventLevel);
Optional.ofNullable(sentryProperties.getLogging().getMinimumLevel())
.map(slf4jLevel -> Level.toLevel(slf4jLevel.name()))
.ifPresent(sentryAppender::setMinimumLevel);

sentryAppender.start();
logger.addAppender(sentryAppender);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,15 @@ public static class Logging {
/** Enable/Disable logging auto-configuration. */
private boolean enabled = true;

/** Minimum logging level for recording breadcrumb. */
/** Minimum logging level for recording breadcrumbs. */
private @Nullable Level minimumBreadcrumbLevel;

/** Minimum logging level for recording event. */
/** Minimum logging level for recording events. */
private @Nullable Level minimumEventLevel;

/** Minimum logging level for recording log events. */
private @Nullable Level minimumLevel;

/** List of loggers the SentryAppender should be added to. */
private @NotNull List<String> loggers = Arrays.asList(org.slf4j.Logger.ROOT_LOGGER_NAME);

Expand Down Expand Up @@ -136,6 +139,14 @@ public void setMinimumEventLevel(@Nullable Level minimumEventLevel) {
this.minimumEventLevel = minimumEventLevel;
}

public @Nullable Level getMinimumLevel() {
return minimumLevel;
}

public void setMinimumLevel(@Nullable Level minimumLevel) {
this.minimumLevel = minimumLevel;
}

@NotNull
public List<String> getLoggers() {
return loggers;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class SentryLogbackAppenderAutoConfigurationTest {
"sentry.dsn=http://key@localhost/proj",
"sentry.logging.minimum-event-level=info",
"sentry.logging.minimum-breadcrumb-level=debug",
"sentry.logging.minimum-level=error",
)
.run {
val appenders = rootLogger.getAppenders(SentryAppender::class.java)
Expand All @@ -92,6 +93,7 @@ class SentryLogbackAppenderAutoConfigurationTest {

assertThat(sentryAppender.minimumBreadcrumbLevel).isEqualTo(Level.DEBUG)
assertThat(sentryAppender.minimumEventLevel).isEqualTo(Level.INFO)
assertThat(sentryAppender.minimumLevel).isEqualTo(Level.ERROR)
}
}

Expand Down
Loading