Send logcat through Sentry Logs (#4487)

* SentryLogcatAdapter now forwards output to Sentry Logs, if enabled

Author: stefanosiano

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Send logcat through Sentry Logs ([#4487](https://github.com/getsentry/sentry-java/pull/4487))
+  - Enable the Logs feature in your `SentryOptions` or with the `io.sentry.logs.enabled` manifest option and the SDK will automatically send logcat logs to Sentry, if the Sentry Android Gradle plugin is applied.
+  - To set the logcat level check the [Logcat integration documentation](https://docs.sentry.io/platforms/android/integrations/logcat/#configure).
+
 ## 8.16.1-alpha.2
 
 ### Fixes

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

@@ -2,8 +2,10 @@
 
 import android.util.Log;
 import io.sentry.Breadcrumb;
+import io.sentry.ScopesAdapter;
 import io.sentry.Sentry;
 import io.sentry.SentryLevel;
+import io.sentry.SentryLogLevel;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -44,73 +46,104 @@ private static void addAsBreadcrumb(
     Sentry.addBreadcrumb(breadcrumb);
   }
 
+  private static void addAsLog(
+      @NotNull final SentryLogLevel level,
+      @Nullable final String msg,
+      @Nullable final Throwable tr) {
+    final @NotNull ScopesAdapter scopes = ScopesAdapter.getInstance();
+    // Check if logs are enabled before doing expensive operations
+    if (!scopes.getOptions().getLogs().isEnabled()) {
+      return;
+    }
+    final @Nullable String trMessage = tr != null ? tr.getMessage() : null;
+    if (tr == null || trMessage == null) {
+      scopes.logger().log(level, msg);
+    } else {
+      scopes.logger().log(level, msg != null ? (msg + "\n" + trMessage) : trMessage);
+    }
+  }
+
   public static int v(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.DEBUG, msg);
+    addAsLog(SentryLogLevel.TRACE, msg, null);
     return Log.v(tag, msg);
   }
 
   public static int v(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.DEBUG, msg, tr);
+    addAsLog(SentryLogLevel.TRACE, msg, tr);
     return Log.v(tag, msg, tr);
   }
 
   public static int d(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.DEBUG, msg);
+    addAsLog(SentryLogLevel.DEBUG, msg, null);
     return Log.d(tag, msg);
   }
 
   public static int d(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.DEBUG, msg, tr);
+    addAsLog(SentryLogLevel.DEBUG, msg, tr);
     return Log.d(tag, msg, tr);
   }
 
   public static int i(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.INFO, msg);
+    addAsLog(SentryLogLevel.INFO, msg, null);
     return Log.i(tag, msg);
   }
 
   public static int i(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.INFO, msg, tr);
+    addAsLog(SentryLogLevel.INFO, msg, tr);
     return Log.i(tag, msg, tr);
   }
 
   public static int w(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.WARNING, msg);
+    addAsLog(SentryLogLevel.WARN, msg, null);
     return Log.w(tag, msg);
   }
 
   public static int w(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.WARNING, msg, tr);
+    addAsLog(SentryLogLevel.WARN, msg, tr);
     return Log.w(tag, msg, tr);
   }
 
   public static int w(@Nullable String tag, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.WARNING, tr);
+    addAsLog(SentryLogLevel.WARN, null, tr);
     return Log.w(tag, tr);
   }
 
   public static int e(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.ERROR, msg);
+    addAsLog(SentryLogLevel.ERROR, msg, null);
     return Log.e(tag, msg);
   }
 
   public static int e(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.ERROR, msg, tr);
+    addAsLog(SentryLogLevel.ERROR, msg, tr);
     return Log.e(tag, msg, tr);
   }
 
   public static int wtf(@Nullable String tag, @Nullable String msg) {
     addAsBreadcrumb(tag, SentryLevel.ERROR, msg);
+    addAsLog(SentryLogLevel.FATAL, msg, null);
     return Log.wtf(tag, msg);
   }
 
   public static int wtf(@Nullable String tag, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.ERROR, tr);
+    addAsLog(SentryLogLevel.FATAL, null, tr);
     return Log.wtf(tag, tr);
   }
 
   public static int wtf(@Nullable String tag, @Nullable String msg, @Nullable Throwable tr) {
     addAsBreadcrumb(tag, SentryLevel.ERROR, msg, tr);
+    addAsLog(SentryLogLevel.FATAL, msg, tr);
     return Log.wtf(tag, msg, tr);
   }
 }

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

@@ -269,6 +269,9 @@ class InternalSentrySdkTest {
 
     // then modifications should not be reflected
     Sentry.configureScope { scope -> assertEquals(3, scope.breadcrumbs.size) }
+
+    // Ensure we don't interfere with other tests
+    Sentry.configureScope(ScopeType.GLOBAL) { scope -> scope.clear() }
   }
 
   @Test