Allow configuration of Sentry Logs for Spring Boot Logback (#4508)

* Add user id, username and email to log attributes

* wip

* Check log event count before sending envelope

* changelog

* Min event level config option; enable logs in logback sample

* Flush logs when client flushes

* Improve log flushing and add test

* review feedback

* Add logs to Spring Boot logback config

* treat unformatted message and params as pii if logback encoder is present

* add tests for pii handling

* adapt pervious changelog entry

Author: adinauer

CHANGELOG.md

@@ -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 -> {

sentry-spring-boot-jakarta/api/sentry-spring-boot-jakarta.api

@@ -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 {

sentry-spring-boot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryLogbackInitializer.java

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

sentry-spring-boot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryProperties.java

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

sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryLogbackAppenderAutoConfigurationTest.kt

@@ -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)
@@ -92,6 +93,7 @@ class SentryLogbackAppenderAutoConfigurationTest {
 
         assertThat(sentryAppender.minimumBreadcrumbLevel).isEqualTo(Level.DEBUG)
         assertThat(sentryAppender.minimumEventLevel).isEqualTo(Level.INFO)
+        assertThat(sentryAppender.minimumLevel).isEqualTo(Level.ERROR)
       }
   }
 

sentry-spring-boot/api/sentry-spring-boot.api

@@ -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 {

sentry-spring-boot/src/main/java/io/sentry/spring/boot/SentryLogbackInitializer.java

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

sentry-spring-boot/src/main/java/io/sentry/spring/boot/SentryProperties.java

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

sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryLogbackAppenderAutoConfigurationTest.kt

@@ -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)
@@ -92,6 +93,7 @@ class SentryLogbackAppenderAutoConfigurationTest {
 
         assertThat(sentryAppender.minimumBreadcrumbLevel).isEqualTo(Level.DEBUG)
         assertThat(sentryAppender.minimumEventLevel).isEqualTo(Level.INFO)
+        assertThat(sentryAppender.minimumLevel).isEqualTo(Level.ERROR)
       }
   }