Merge branch 'main' into feat/log4j2-logs

Author: adinauer

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## Unreleased
+## 8.15.1
+
+### Fixes
+
+- Enabling Sentry Logs through Logback in Spring Boot config did not work in 3.15.0 ([#4523](https://github.com/getsentry/sentry-java/pull/4523))
+
+## 8.15.0
 
 ### Features
 
@@ -13,6 +19,7 @@
 - Log parameter objects are now turned into `String` via `toString` ([#4515](https://github.com/getsentry/sentry-java/pull/4515))
   - One of the two `SentryLogEventAttributeValue` constructors did not convert the value previously.
 - Logs are now flushed on shutdown ([#4503](https://github.com/getsentry/sentry-java/pull/4503))
+- User Feedback: Do not redefine system attributes for `SentryUserFeedbackButton`, but reference them instead ([#4519](https://github.com/getsentry/sentry-java/pull/4519))
 
 ### Features
 
@@ -52,6 +59,7 @@
     ```properties
     logs.enabled=true
     ```
+- Automatically use `SentryOptions.Logs.BeforeSendLogCallback` Spring beans ([#4509](https://github.com/getsentry/sentry-java/pull/4509))
 
 ### Dependencies
 

gradle.properties

@@ -11,7 +11,7 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 android.useAndroidX=true
 
 # Release information
-versionName=8.14.0
+versionName=8.15.1
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackDialog.java

@@ -12,6 +12,7 @@
 import io.sentry.IScopes;
 import io.sentry.Sentry;
 import io.sentry.SentryFeedbackOptions;
+import io.sentry.SentryIntegrationPackageStorage;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.protocol.Feedback;
@@ -34,6 +35,7 @@ public final class SentryUserFeedbackDialog extends AlertDialog {
       final @Nullable OptionsConfiguration configuration) {
     super(context, themeResId);
     this.configuration = configuration;
+    SentryIntegrationPackageStorage.getInstance().addIntegration("UserFeedbackWidget");
   }
 
   @Override

sentry-android-core/src/main/res/values/attrs.xml

@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
+  <!-- We have to omit 'format' here as we're referencing the system attributes from the '@android:' namespace -->
   <declare-styleable name="SentryUserFeedbackButton" >
-    <attr name="android:drawableStart" format="reference" />
-    <attr name="android:drawablePadding" format="dimension" />
-    <attr name="android:padding" format="dimension" />
-    <attr name="android:textAllCaps" format="boolean" />
-    <attr name="android:background" format="reference|color" />
-    <attr name="android:textColor" format="reference|color" />
-    <attr name="android:text" format="string" />
+    <attr name="android:drawableStart" />
+    <attr name="android:drawablePadding" />
+    <attr name="android:padding" />
+    <attr name="android:textAllCaps" />
+    <attr name="android:background" />
+    <attr name="android:textColor" />
+    <attr name="android:text" />
   </declare-styleable>
 </resources>

sentry-android-integration-tests/sentry-uitest-android/src/main/res/values/values.xml

@@ -1,4 +1,15 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources xmlns:tools="http://schemas.android.com/tools">
+  <!-- Just a dummy styleable to verify resource merging -->
+  <declare-styleable name="DummyStyle" >
+    <attr name="android:drawableStart" format="reference" />
+    <attr name="android:drawablePadding" format="dimension" />
+    <attr name="android:padding" format="dimension" />
+    <attr name="android:textAllCaps" format="boolean" />
+    <attr name="android:background" format="reference|color" />
+    <attr name="android:textColor" format="reference|color" />
+    <attr name="android:text" format="string" />
+  </declare-styleable>
+
   <bool tools:ignore="UnusedResources" name="leak_canary_allow_in_non_debuggable_build">true</bool>
 </resources>

sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java

@@ -83,7 +83,8 @@ public void start() {
 
   @Override
   protected void append(@NotNull ILoggingEvent eventObject) {
-    if (options.getLogs().isEnabled() && eventObject.getLevel().isGreaterOrEqual(minimumLevel)) {
+    if (ScopesAdapter.getInstance().getOptions().getLogs().isEnabled()
+        && eventObject.getLevel().isGreaterOrEqual(minimumLevel)) {
       captureLog(eventObject);
     }
     if (eventObject.getLevel().isGreaterOrEqual(minimumEventLevel)) {
@@ -113,7 +114,7 @@ protected void append(@NotNull ILoggingEvent eventObject) {
     final Message message = new Message();
 
     // if encoder is set we treat message+params as PII as encoders may be used to mask/strip PII
-    if (encoder == null || options.isSendDefaultPii()) {
+    if (encoder == null || ScopesAdapter.getInstance().getOptions().isSendDefaultPii()) {
       message.setMessage(loggingEvent.getMessage());
       message.setParams(toParams(loggingEvent.getArgumentArray()));
     }
@@ -184,7 +185,7 @@ protected void captureLog(@NotNull ILoggingEvent loggingEvent) {
     final @NotNull SentryAttributes attributes = SentryAttributes.of();
 
     // if encoder is set we treat message+params as PII as encoders may be used to mask/strip PII
-    if (encoder == null || options.isSendDefaultPii()) {
+    if (encoder == null || ScopesAdapter.getInstance().getOptions().isSendDefaultPii()) {
       attributes.add(
           SentryAttribute.stringAttribute("sentry.message.template", loggingEvent.getMessage()));
       arguments = loggingEvent.getArgumentArray();

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 {