Introduce fatal SDK logger

Author: adinauer

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

@@ -0,0 +1,68 @@
+package io.sentry.android.core;
+
+import android.util.Log;
+
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import io.sentry.ILogger;
+import io.sentry.SentryLevel;
+
+@ApiStatus.Internal
+public final class AndroidFatalLogger implements ILogger {
+
+  private final @NotNull String tag;
+
+  public AndroidFatalLogger() {
+    this("Sentry");
+  }
+
+  public AndroidFatalLogger(final @NotNull String tag) {
+    this.tag = tag;
+  }
+
+  @SuppressWarnings("AnnotateFormatMethod")
+  @Override
+  public void log(
+      final @NotNull SentryLevel level,
+      final @NotNull String message,
+      final @Nullable Object... args) {
+    if (args == null || args.length == 0) {
+      Log.println(toLogcatLevel(level), tag, message);
+    } else {
+      Log.println(toLogcatLevel(level), tag, String.format(message, args));
+    }
+  }
+
+  @SuppressWarnings("AnnotateFormatMethod")
+  @Override
+  public void log(
+      final @NotNull SentryLevel level,
+      final @Nullable Throwable throwable,
+      final @NotNull String message,
+      final @Nullable Object... args) {
+    if (args == null || args.length == 0) {
+      log(level, message, throwable);
+    } else {
+      log(level, String.format(message, args), throwable);
+    }
+  }
+
+  @Override
+  public void log(
+      final @NotNull SentryLevel level,
+      final @NotNull String message,
+      final @Nullable Throwable throwable) {
+    Log.wtf(tag, message, throwable);
+  }
+
+  @Override
+  public boolean isEnabled(@Nullable SentryLevel level) {
+    return true;
+  }
+
+  private int toLogcatLevel(final @NotNull SentryLevel sentryLevel) {
+    return Log.ASSERT;
+  }
+}

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

@@ -110,6 +110,7 @@ static void loadDefaultAndMetadataOptions(
 
     // Firstly set the logger, if `debug=true` configured, logging can start asap.
     options.setLogger(logger);
+    options.setFatalLogger(new AndroidFatalLogger());
 
     options.setDefaultScopeType(ScopeType.CURRENT);
     options.setOpenTelemetryMode(SentryOpenTelemetryMode.OFF);

sentry/src/main/java/io/sentry/DefaultVersionDetector.java

@@ -14,6 +14,6 @@ public DefaultVersionDetector(final @NotNull SentryOptions options) {
 
   @Override
   public boolean checkForMixedVersions() {
-    return SentryIntegrationPackageStorage.getInstance().checkForMixedVersions(options.getLogger());
+    return SentryIntegrationPackageStorage.getInstance().checkForMixedVersions(options.getFatalLogger());
   }
 }

sentry/src/main/java/io/sentry/ManifestVersionDetector.java

@@ -16,6 +16,6 @@ public ManifestVersionDetector(final @NotNull SentryOptions options) {
   @Override
   public boolean checkForMixedVersions() {
     ManifestVersionReader.getInstance().readManifestFiles();
-    return SentryIntegrationPackageStorage.getInstance().checkForMixedVersions(options.getLogger());
+    return SentryIntegrationPackageStorage.getInstance().checkForMixedVersions(options.getFatalLogger());
   }
 }

sentry/src/main/java/io/sentry/Sentry.java

@@ -292,6 +292,7 @@ private static void init(final @NotNull SentryOptions options, final boolean glo
           .getLogger()
           .log(SentryLevel.INFO, "GlobalHubMode: '%s'", String.valueOf(globalHubModeToUse));
       Sentry.globalHubMode = globalHubModeToUse;
+      initFatalLogger(options);
       final boolean shouldInit =
           InitUtil.shouldInit(globalScope.getOptions(), options, isEnabled());
       if (shouldInit) {
@@ -392,6 +393,12 @@ private static void initLogger(final @NotNull SentryOptions options) {
     }
   }
 
+  private static void initFatalLogger(final @NotNull SentryOptions options) {
+    if (options.getFatalLogger() instanceof NoOpLogger) {
+      options.setFatalLogger(new SystemOutLogger());
+    }
+  }
+
   private static void initScopesStorage(SentryOptions options) {
     getScopesStorage().close();
     if (SentryOpenTelemetryMode.OFF == options.getOpenTelemetryMode()) {

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -126,6 +126,8 @@ public class SentryOptions {
 
   /** Logger interface to log useful debugging information if debug is enabled */
   private @NotNull ILogger logger = NoOpLogger.getInstance();
+  @ApiStatus.Experimental
+  private @NotNull ILogger fatalLogger = NoOpLogger.getInstance();
 
   /** minimum LogLevel to be used if debug is enabled */
   private @NotNull SentryLevel diagnosticLevel = DEFAULT_DIAGNOSTIC_LEVEL;
@@ -646,6 +648,26 @@ public void setLogger(final @Nullable ILogger logger) {
     this.logger = (logger == null) ? NoOpLogger.getInstance() : new DiagnosticLogger(this, logger);
   }
 
+  /**
+   * Returns the Logger interface for logging important SDK messages
+   *
+   * @return the logger for fatal SDK messages
+   */
+  @ApiStatus.Experimental
+  public @NotNull ILogger getFatalLogger() {
+    return fatalLogger;
+  }
+
+  /**
+   * Sets the Logger interface for important SDK messages. If null, logger will be NoOp
+   *
+   * @param logger the logger for fatal SDK messages
+   */
+  @ApiStatus.Experimental
+  public void setFatalLogger(final @Nullable ILogger logger) {
+    this.fatalLogger = (logger == null) ? NoOpLogger.getInstance() : logger;
+  }
+
   /**
    * Returns the minimum LogLevel
    *