Automatically use SentryOptions.Logs.BeforeSendLogCallback Spring beans (#4509)

* 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

* Auto pick up logs.beforeSend from Spring beans

* changelog

Author: adinauer

CHANGELOG.md

@@ -52,6 +52,7 @@
     ```properties
     logs.enabled=true
     ```
+- Automatically use `SentryOptions.Logs.BeforeSendLogCallback` Spring beans ([#4509](https://github.com/getsentry/sentry-java/pull/4509))
 
 ### Dependencies
 

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

@@ -103,6 +103,8 @@ static class HubConfiguration {
         final @NotNull ObjectProvider<SentryOptions.BeforeSendCallback> beforeSendCallback,
         final @NotNull ObjectProvider<SentryOptions.BeforeSendTransactionCallback>
                 beforeSendTransactionCallback,
+        final @NotNull ObjectProvider<SentryOptions.Logs.BeforeSendLogCallback>
+                beforeSendLogsCallback,
         final @NotNull ObjectProvider<SentryOptions.BeforeBreadcrumbCallback>
                 beforeBreadcrumbCallback,
         final @NotNull ObjectProvider<SentryOptions.TracesSamplerCallback> tracesSamplerCallback,
@@ -114,6 +116,7 @@ static class HubConfiguration {
       return options -> {
         beforeSendCallback.ifAvailable(options::setBeforeSend);
         beforeSendTransactionCallback.ifAvailable(options::setBeforeSendTransaction);
+        beforeSendLogsCallback.ifAvailable(callback -> options.getLogs().setBeforeSend(callback));
         beforeBreadcrumbCallback.ifAvailable(options::setBeforeBreadcrumb);
         tracesSamplerCallback.ifAvailable(options::setTracesSampler);
         eventProcessors.forEach(options::addEventProcessor);

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

@@ -16,6 +16,7 @@ import io.sentry.Sentry
 import io.sentry.SentryEvent
 import io.sentry.SentryIntegrationPackageStorage
 import io.sentry.SentryLevel
+import io.sentry.SentryLogEvent
 import io.sentry.SentryOptions
 import io.sentry.checkEvent
 import io.sentry.opentelemetry.SentryAutoConfigurationCustomizerProvider
@@ -350,6 +351,17 @@ class SentryAutoConfigurationTest {
       }
   }
 
+  @Test
+  fun `registers logs beforeSendCallback on SentryOptions`() {
+    contextRunner
+      .withPropertyValues("sentry.dsn=http://key@localhost/proj")
+      .withUserConfiguration(CustomBeforeSendLogsCallbackConfiguration::class.java)
+      .run {
+        assertThat(it.getBean(SentryOptions::class.java).logs.beforeSend)
+          .isInstanceOf(CustomBeforeSendLogsCallback::class.java)
+      }
+  }
+
   @Test
   fun `registers beforeBreadcrumbCallback on SentryOptions`() {
     contextRunner
@@ -1095,6 +1107,16 @@ class SentryAutoConfigurationTest {
     override fun execute(event: SentryEvent, hint: Hint): SentryEvent? = null
   }
 
+  @Configuration(proxyBeanMethods = false)
+  open class CustomBeforeSendLogsCallbackConfiguration {
+
+    @Bean open fun beforeSendCallback() = CustomBeforeSendLogsCallback()
+  }
+
+  class CustomBeforeSendLogsCallback : SentryOptions.Logs.BeforeSendLogCallback {
+    override fun execute(event: SentryLogEvent): SentryLogEvent? = null
+  }
+
   @Configuration(proxyBeanMethods = false)
   open class CustomBeforeSendTransactionCallbackConfiguration {
 

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

@@ -101,6 +101,8 @@ static class HubConfiguration {
         final @NotNull ObjectProvider<SentryOptions.BeforeSendCallback> beforeSendCallback,
         final @NotNull ObjectProvider<SentryOptions.BeforeSendTransactionCallback>
                 beforeSendTransactionCallback,
+        final @NotNull ObjectProvider<SentryOptions.Logs.BeforeSendLogCallback>
+                beforeSendLogsCallback,
         final @NotNull ObjectProvider<SentryOptions.BeforeBreadcrumbCallback>
                 beforeBreadcrumbCallback,
         final @NotNull ObjectProvider<SentryOptions.TracesSamplerCallback> tracesSamplerCallback,
@@ -112,6 +114,7 @@ static class HubConfiguration {
       return options -> {
         beforeSendCallback.ifAvailable(options::setBeforeSend);
         beforeSendTransactionCallback.ifAvailable(options::setBeforeSendTransaction);
+        beforeSendLogsCallback.ifAvailable(callback -> options.getLogs().setBeforeSend(callback));
         beforeBreadcrumbCallback.ifAvailable(options::setBeforeBreadcrumb);
         tracesSamplerCallback.ifAvailable(options::setTracesSampler);
         eventProcessors.forEach(options::addEventProcessor);

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

@@ -16,6 +16,7 @@ import io.sentry.Sentry
 import io.sentry.SentryEvent
 import io.sentry.SentryIntegrationPackageStorage
 import io.sentry.SentryLevel
+import io.sentry.SentryLogEvent
 import io.sentry.SentryOptions
 import io.sentry.checkEvent
 import io.sentry.opentelemetry.SentryAutoConfigurationCustomizerProvider
@@ -338,6 +339,17 @@ class SentryAutoConfigurationTest {
       }
   }
 
+  @Test
+  fun `registers logs beforeSendCallback on SentryOptions`() {
+    contextRunner
+      .withPropertyValues("sentry.dsn=http://key@localhost/proj")
+      .withUserConfiguration(CustomBeforeSendLogsCallbackConfiguration::class.java)
+      .run {
+        assertThat(it.getBean(SentryOptions::class.java).logs.beforeSend)
+          .isInstanceOf(CustomBeforeSendLogsCallback::class.java)
+      }
+  }
+
   @Test
   fun `registers beforeSendTransactionCallback on SentryOptions`() {
     contextRunner
@@ -1021,6 +1033,16 @@ class SentryAutoConfigurationTest {
     override fun execute(event: SentryEvent, hint: Hint): SentryEvent? = null
   }
 
+  @Configuration(proxyBeanMethods = false)
+  open class CustomBeforeSendLogsCallbackConfiguration {
+
+    @Bean open fun beforeSendCallback() = CustomBeforeSendLogsCallback()
+  }
+
+  class CustomBeforeSendLogsCallback : SentryOptions.Logs.BeforeSendLogCallback {
+    override fun execute(event: SentryLogEvent): SentryLogEvent? = null
+  }
+
   @Configuration(proxyBeanMethods = false)
   open class CustomBeforeSendTransactionCallbackConfiguration {