Merge branch 'main' into rz/fix/previous-session-flush-wait

Author: romtsn

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 - Session Replay: Use main thread looper to schedule replay capture ([#4542](https://github.com/getsentry/sentry-java/pull/4542))
 - Use single `LifecycleObserver` and multi-cast it to the integrations interested in lifecycle states ([#4567](https://github.com/getsentry/sentry-java/pull/4567))
+- Add `sentry.origin` attribute to logs ([#4618](https://github.com/getsentry/sentry-java/pull/4618))
+  - This helps identify which integration captured a log event
 - Prewarm `SentryExecutorService` for better performance at runtime ([#4606](https://github.com/getsentry/sentry-java/pull/4606))
 
 ### Fixes
@@ -24,6 +26,8 @@
   ```
 - Fix abstract method error in `SentrySupportSQLiteDatabase` ([#4597](https://github.com/getsentry/sentry-java/pull/4597))
 - Ensure frame metrics listeners are registered/unregistered on the main thread ([#4582](https://github.com/getsentry/sentry-java/pull/4582))
+- Do not report cached events as lost ([#4575](https://github.com/getsentry/sentry-java/pull/4575))
+  - Previously events were recorded as lost early despite being retried later through the cache
 
 ## 8.18.0
 

sentry-android-core/api/sentry-android-core.api

@@ -483,6 +483,7 @@ public final class io/sentry/android/core/cache/AndroidEnvelopeCache : io/sentry
 	public static fun hasStartupCrashMarker (Lio/sentry/SentryOptions;)Z
 	public static fun lastReportedAnr (Lio/sentry/SentryOptions;)Ljava/lang/Long;
 	public fun store (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)V
+	public fun storeEnvelope (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)Z
 }
 
 public class io/sentry/android/core/performance/ActivityLifecycleCallbacksAdapter : android/app/Application$ActivityLifecycleCallbacks {

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

@@ -6,6 +6,7 @@
 import io.sentry.Sentry;
 import io.sentry.SentryLevel;
 import io.sentry.SentryLogLevel;
+import io.sentry.logger.SentryLogParameters;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -56,10 +57,13 @@ private static void addAsLog(
       return;
     }
     final @Nullable String trMessage = tr != null ? tr.getMessage() : null;
+    final @NotNull SentryLogParameters params = new SentryLogParameters();
+    params.setOrigin("auto.log.logcat");
+
     if (tr == null || trMessage == null) {
-      scopes.logger().log(level, msg);
+      scopes.logger().log(level, params, msg);
     } else {
-      scopes.logger().log(level, msg != null ? (msg + "\n" + trMessage) : trMessage);
+      scopes.logger().log(level, params, msg != null ? (msg + "\n" + trMessage) : trMessage);
     }
   }
 

sentry-android-core/src/main/java/io/sentry/android/core/cache/AndroidEnvelopeCache.java

@@ -47,9 +47,19 @@ public AndroidEnvelopeCache(final @NotNull SentryAndroidOptions options) {
     this.currentDateProvider = currentDateProvider;
   }
 
+  @SuppressWarnings("deprecation")
   @Override
   public void store(@NotNull SentryEnvelope envelope, @NotNull Hint hint) {
-    super.store(envelope, hint);
+    storeInternalAndroid(envelope, hint);
+  }
+
+  @Override
+  public boolean storeEnvelope(@NotNull SentryEnvelope envelope, @NotNull Hint hint) {
+    return storeInternalAndroid(envelope, hint);
+  }
+
+  private boolean storeInternalAndroid(@NotNull SentryEnvelope envelope, @NotNull Hint hint) {
+    final boolean didStore = super.storeEnvelope(envelope, hint);
 
     final SentryAndroidOptions options = (SentryAndroidOptions) this.options;
     final TimeSpan sdkInitTimeSpan = AppStartMetrics.getInstance().getSdkInitTimeSpan();
@@ -83,6 +93,7 @@ public void store(@NotNull SentryEnvelope envelope, @NotNull Hint hint) {
 
           writeLastReportedAnrMarker(timestamp);
         });
+    return didStore;
   }
 
   @TestOnly

sentry-android-core/src/test/java/io/sentry/android/core/SentryLogcatAdapterTest.kt

@@ -64,6 +64,7 @@ class SentryLogcatAdapterTest {
     SentryLogcatAdapter.v(tag, "$commonMsg verbose")
     fixture.breadcrumbs.first().assert(tag, "$commonMsg verbose", SentryLevel.DEBUG)
     fixture.logs.first().assert("$commonMsg verbose", SentryLogLevel.TRACE)
+    assertEquals("auto.log.logcat", fixture.logs.first().attributes?.get("sentry.origin")?.value)
   }
 
   @Test

sentry-android-core/src/test/java/io/sentry/android/core/cache/AndroidEnvelopeCacheTest.kt

@@ -1,7 +1,9 @@
 package io.sentry.android.core.cache
 
+import io.sentry.ISerializer
 import io.sentry.NoOpLogger
 import io.sentry.SentryEnvelope
+import io.sentry.SentryOptions
 import io.sentry.UncaughtExceptionHandlerIntegration.UncaughtExceptionHint
 import io.sentry.android.core.AnrV2Integration.AnrV2Hint
 import io.sentry.android.core.SentryAndroidOptions
@@ -18,7 +20,9 @@ import kotlin.test.assertFalse
 import kotlin.test.assertTrue
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
+import org.mockito.kotlin.any
 import org.mockito.kotlin.mock
+import org.mockito.kotlin.same
 import org.mockito.kotlin.whenever
 
 class AndroidEnvelopeCacheTest {
@@ -35,8 +39,10 @@ class AndroidEnvelopeCacheTest {
       dir: TemporaryFolder,
       appStartMillis: Long? = null,
       currentTimeMillis: Long? = null,
+      optionsCallback: ((SentryOptions) -> Unit)? = null,
     ): AndroidEnvelopeCache {
       options.cacheDirPath = dir.newFolder("sentry-cache").absolutePath
+      optionsCallback?.invoke(options)
       val outboxDir = File(options.outboxPath!!)
       outboxDir.mkdirs()
 
@@ -82,7 +88,7 @@ class AndroidEnvelopeCacheTest {
     val cache = fixture.getSut(tmpDir)
 
     val hints = HintUtils.createWithTypeCheckHint(UncaughtHint())
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertFalse(fixture.startupCrashMarkerFile.exists())
   }
@@ -92,7 +98,7 @@ class AndroidEnvelopeCacheTest {
     val cache = fixture.getSut(dir = tmpDir, appStartMillis = 1000L, currentTimeMillis = 5000L)
 
     val hints = HintUtils.createWithTypeCheckHint(UncaughtHint())
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertFalse(fixture.startupCrashMarkerFile.exists())
   }
@@ -104,7 +110,7 @@ class AndroidEnvelopeCacheTest {
     fixture.options.cacheDirPath = null
 
     val hints = HintUtils.createWithTypeCheckHint(UncaughtHint())
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertFalse(fixture.startupCrashMarkerFile.exists())
   }
@@ -114,7 +120,7 @@ class AndroidEnvelopeCacheTest {
     val cache = fixture.getSut(dir = tmpDir, appStartMillis = 1000L, currentTimeMillis = 2000L)
 
     val hints = HintUtils.createWithTypeCheckHint(UncaughtHint())
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertTrue(fixture.startupCrashMarkerFile.exists())
   }
@@ -138,7 +144,7 @@ class AndroidEnvelopeCacheTest {
       HintUtils.createWithTypeCheckHint(
         AnrV2Hint(0, NoOpLogger.getInstance(), 12345678L, false, false)
       )
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertFalse(fixture.lastReportedAnrFile.exists())
   }
@@ -151,7 +157,7 @@ class AndroidEnvelopeCacheTest {
       HintUtils.createWithTypeCheckHint(
         AnrV2Hint(0, NoOpLogger.getInstance(), 12345678L, false, false)
       )
-    cache.store(fixture.envelope, hints)
+    cache.storeEnvelope(fixture.envelope, hints)
 
     assertTrue(fixture.lastReportedAnrFile.exists())
     assertEquals("12345678", fixture.lastReportedAnrFile.readText())
@@ -189,5 +195,17 @@ class AndroidEnvelopeCacheTest {
     assertEquals(87654321L, lastReportedAnr)
   }
 
+  @Test
+  fun `returns false if storing fails`() {
+    val serializer = mock<ISerializer>()
+    val cache = fixture.getSut(tmpDir) { options -> options.setSerializer(serializer) }
+    whenever(serializer.serialize(same(fixture.envelope), any()))
+      .thenThrow(RuntimeException("forced ex"))
+    val hints = HintUtils.createWithTypeCheckHint(UncaughtHint())
+
+    val didStore = cache.storeEnvelope(fixture.envelope, hints)
+    assertFalse(didStore)
+  }
+
   internal class UncaughtHint : UncaughtExceptionHint(0, NoOpLogger.getInstance())
 }

sentry-android-timber/src/main/java/io/sentry/android/timber/SentryTimberTree.kt

@@ -6,6 +6,7 @@ import io.sentry.IScopes
 import io.sentry.SentryEvent
 import io.sentry.SentryLevel
 import io.sentry.SentryLogLevel
+import io.sentry.logger.SentryLogParameters
 import io.sentry.protocol.Message
 import timber.log.Timber
 
@@ -244,12 +245,15 @@ public class SentryTimberTree(
   ) {
     // checks the log level
     if (isLoggable(sentryLogLevel, minLogLevel)) {
+      val params = SentryLogParameters()
+      params.origin = "auto.log.timber"
+
       val throwableMsg = throwable?.message
       when {
         msg != null && throwableMsg != null ->
-          scopes.logger().log(sentryLogLevel, "$msg\n$throwableMsg", *args)
-        msg != null -> scopes.logger().log(sentryLogLevel, msg, *args)
-        throwableMsg != null -> scopes.logger().log(sentryLogLevel, throwableMsg, *args)
+          scopes.logger().log(sentryLogLevel, params, "$msg\n$throwableMsg", *args)
+        msg != null -> scopes.logger().log(sentryLogLevel, params, msg, *args)
+        throwableMsg != null -> scopes.logger().log(sentryLogLevel, params, throwableMsg, *args)
       }
     }
   }

sentry-android-timber/src/test/java/io/sentry/android/timber/SentryTimberTreeTest.kt

@@ -5,6 +5,7 @@ import io.sentry.Scopes
 import io.sentry.SentryLevel
 import io.sentry.SentryLogLevel
 import io.sentry.logger.ILoggerApi
+import io.sentry.logger.SentryLogParameters
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -248,21 +249,28 @@ class SentryTimberTreeTest {
     val sut = fixture.getSut()
     sut.e("test count: %d %d", 32, 5)
 
-    verify(fixture.logs).log(eq(SentryLogLevel.ERROR), eq("test count: %d %d"), eq(32), eq(5))
+    verify(fixture.logs)
+      .log(
+        eq(SentryLogLevel.ERROR),
+        check<SentryLogParameters> { assertEquals("auto.log.timber", it.origin) },
+        eq("test count: %d %d"),
+        eq(32),
+        eq(5),
+      )
   }
 
   @Test
   fun `Tree adds a log if min level is equal`() {
     val sut = fixture.getSut()
     sut.i(Throwable("test"))
-    verify(fixture.logs).log(any(), any())
+    verify(fixture.logs).log(any(), any<SentryLogParameters>(), any<String>())
   }
 
   @Test
   fun `Tree adds a log if min level is higher`() {
     val sut = fixture.getSut()
     sut.e(Throwable("test"))
-    verify(fixture.logs).log(any(), any<String>(), any())
+    verify(fixture.logs).log(any(), any<SentryLogParameters>(), any<String>(), any())
   }
 
   @Test
@@ -277,15 +285,25 @@ class SentryTimberTreeTest {
     val sut = fixture.getSut()
     sut.i("message")
 
-    verify(fixture.logs).log(eq(SentryLogLevel.INFO), eq("message"))
+    verify(fixture.logs)
+      .log(
+        eq(SentryLogLevel.INFO),
+        check<SentryLogParameters> { assertEquals("auto.log.timber", it.origin) },
+        eq("message"),
+      )
   }
 
   @Test
   fun `Tree adds an error log`() {
     val sut = fixture.getSut()
     sut.e(Throwable("test"))
 
-    verify(fixture.logs).log(eq(SentryLogLevel.ERROR), eq("test"))
+    verify(fixture.logs)
+      .log(
+        eq(SentryLogLevel.ERROR),
+        check<SentryLogParameters> { assertEquals("auto.log.timber", it.origin) },
+        eq("test"),
+      )
   }
 
   @Test
@@ -300,14 +318,24 @@ class SentryTimberTreeTest {
     val sut = fixture.getSut()
     sut.e(Throwable("throwable message"))
 
-    verify(fixture.logs).log(eq(SentryLogLevel.ERROR), eq("throwable message"))
+    verify(fixture.logs)
+      .log(
+        eq(SentryLogLevel.ERROR),
+        check<SentryLogParameters> { assertEquals("auto.log.timber", it.origin) },
+        eq("throwable message"),
+      )
   }
 
   @Test
   fun `Tree logs throwable and message`() {
     val sut = fixture.getSut()
     sut.e(Throwable("throwable message"), "My message")
 
-    verify(fixture.logs).log(eq(SentryLogLevel.ERROR), eq("My message\nthrowable message"))
+    verify(fixture.logs)
+      .log(
+        eq(SentryLogLevel.ERROR),
+        check<SentryLogParameters> { assertEquals("auto.log.timber", it.origin) },
+        eq("My message\nthrowable message"),
+      )
   }
 }

sentry-jul/src/main/java/io/sentry/jul/SentryHandler.java

@@ -158,6 +158,7 @@ protected void captureLog(@NotNull LogRecord loggingEvent) {
 
     final @NotNull String formattedMessage = maybeFormatted(arguments, message);
     final @NotNull SentryLogParameters params = SentryLogParameters.create(attributes);
+    params.setOrigin("auto.log.jul");
 
     Sentry.logger().log(sentryLevel, params, formattedMessage, arguments);
   }

sentry-jul/src/test/kotlin/io/sentry/jul/SentryHandlerTest.kt

@@ -414,7 +414,12 @@ class SentryHandlerTest {
     Sentry.flush(1000)
 
     verify(fixture.transport)
-      .send(checkLogs { event -> assertEquals(SentryLogLevel.TRACE, event.items.first().level) })
+      .send(
+        checkLogs { event ->
+          assertEquals(SentryLogLevel.TRACE, event.items.first().level)
+          assertEquals("auto.log.jul", event.items.first().attributes?.get("sentry.origin")?.value)
+        }
+      )
   }
 
   @Test