Add options.printUncaughtStackTrace (#1890)

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Fix: NPE while adding "response_body_size" breadcrumb, when response body is null (#1884)
 * Bump: AGP to 7.1.0 (#1892)
+* Feat: Add options.printUncaughtStackTrace to print uncaught exceptions (#1890)
 
 ## 5.6.0
 

sentry/api/sentry.api

@@ -854,6 +854,7 @@ public class io/sentry/SentryOptions {
 	public fun getMaxRequestBodySize ()Lio/sentry/SentryOptions$RequestSize;
 	public fun getMaxSpans ()I
 	public fun getOutboxPath ()Ljava/lang/String;
+	public fun getPrintUncaughtStackTrace ()Ljava/lang/Boolean;
 	public fun getProguardUuid ()Ljava/lang/String;
 	public fun getProxy ()Lio/sentry/SentryOptions$Proxy;
 	public fun getReadTimeoutMillis ()I
@@ -884,6 +885,7 @@ public class io/sentry/SentryOptions {
 	public fun isEnableSessionTracking ()Z
 	public fun isEnableShutdownHook ()Z
 	public fun isEnableUncaughtExceptionHandler ()Z
+	public fun isPrintUncaughtStackTrace ()Z
 	public fun isSendDefaultPii ()Z
 	public fun isTraceSampling ()Z
 	public fun isTracingEnabled ()Z
@@ -920,6 +922,7 @@ public class io/sentry/SentryOptions {
 	public fun setMaxQueueSize (I)V
 	public fun setMaxRequestBodySize (Lio/sentry/SentryOptions$RequestSize;)V
 	public fun setMaxSpans (I)V
+	public fun setPrintUncaughtStackTrace (Ljava/lang/Boolean;)V
 	public fun setProguardUuid (Ljava/lang/String;)V
 	public fun setProxy (Lio/sentry/SentryOptions$Proxy;)V
 	public fun setReadTimeoutMillis (I)V

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

@@ -220,6 +220,12 @@ public class SentryOptions {
    */
   private @Nullable Boolean enableUncaughtExceptionHandler = true;
 
+  /*
+   * When enabled, UncaughtExceptionHandler will print exceptions (same as java would normally do),
+   * if no other UncaughtExceptionHandler was registered before.
+   */
+  private @Nullable Boolean printUncaughtStackTrace = false;
+
   /** Sentry Executor Service that sends cached events and envelopes on App. start. */
   private @NotNull ISentryExecutorService executorService = NoOpSentryExecutorService.getInstance();
 
@@ -309,6 +315,8 @@ public class SentryOptions {
     options.setServerName(propertiesProvider.getProperty("servername"));
     options.setEnableUncaughtExceptionHandler(
         propertiesProvider.getBooleanProperty("uncaught.handler.enabled"));
+    options.setPrintUncaughtStackTrace(
+        propertiesProvider.getBooleanProperty("uncaught.handler.print-stacktrace"));
     options.setTracesSampleRate(propertiesProvider.getDoubleProperty("traces-sample-rate"));
     options.setDebug(propertiesProvider.getBooleanProperty("debug"));
     options.setEnableDeduplication(propertiesProvider.getBooleanProperty("enable-deduplication"));
@@ -1070,6 +1078,33 @@ public void setEnableUncaughtExceptionHandler(
     this.enableUncaughtExceptionHandler = enableUncaughtExceptionHandler;
   }
 
+  /**
+   * Checks if printing exceptions by UncaughtExceptionHandler is enabled or disabled.
+   *
+   * @return true if enabled or false otherwise.
+   */
+  public boolean isPrintUncaughtStackTrace() {
+    return Boolean.TRUE.equals(printUncaughtStackTrace);
+  }
+
+  /**
+   * Checks if printing exceptions by UncaughtExceptionHandler is enabled or disabled.
+   *
+   * @return true if enabled, false otherwise or null if not set.
+   */
+  public @Nullable Boolean getPrintUncaughtStackTrace() {
+    return printUncaughtStackTrace;
+  }
+
+  /**
+   * Enable or disable printing exceptions in UncaughtExceptionHandler
+   *
+   * @param printUncaughtStackTrace true if enabled or false otherwise.
+   */
+  public void setPrintUncaughtStackTrace(final @Nullable Boolean printUncaughtStackTrace) {
+    this.printUncaughtStackTrace = printUncaughtStackTrace;
+  }
+
   /**
    * Returns the SentryExecutorService
    *
@@ -1622,6 +1657,9 @@ void merge(final @NotNull SentryOptions options) {
     if (options.getEnableUncaughtExceptionHandler() != null) {
       setEnableUncaughtExceptionHandler(options.getEnableUncaughtExceptionHandler());
     }
+    if (options.getPrintUncaughtStackTrace() != null) {
+      setPrintUncaughtStackTrace(options.getPrintUncaughtStackTrace());
+    }
     if (options.getTracesSampleRate() != null) {
       setTracesSampleRate(options.getTracesSampleRate());
     }

sentry/src/main/java/io/sentry/UncaughtExceptionHandlerIntegration.java

@@ -112,6 +112,10 @@ public void uncaughtException(Thread thread, Throwable thrown) {
       if (defaultExceptionHandler != null) {
         options.getLogger().log(SentryLevel.INFO, "Invoking inner uncaught exception handler.");
         defaultExceptionHandler.uncaughtException(thread, thrown);
+      } else {
+        if (options.isPrintUncaughtStackTrace()) {
+          thrown.printStackTrace();
+        }
       }
     }
   }

sentry/src/test/java/io/sentry/UncaughtExceptionHandlerIntegrationTest.kt

@@ -9,7 +9,9 @@ import com.nhaarman.mockitokotlin2.whenever
 import io.sentry.exception.ExceptionMechanismException
 import io.sentry.protocol.SentryId
 import io.sentry.util.noFlushTimeout
+import java.io.ByteArrayOutputStream
 import java.io.File
+import java.io.PrintStream
 import java.nio.file.Files
 import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
@@ -150,4 +152,31 @@ class UncaughtExceptionHandlerIntegrationTest {
         integration.close()
         verify(handlerMock).defaultUncaughtExceptionHandler = null
     }
+
+    @Test
+    fun `When printUncaughtStackTrace is enabled, prints the stacktrace to standard error`() {
+        val standardErr = System.err
+        try {
+            val outputStreamCaptor = ByteArrayOutputStream()
+            System.setErr(PrintStream(outputStreamCaptor))
+
+            val handlerMock = mock<UncaughtExceptionHandler>()
+            val options = SentryOptions().noFlushTimeout()
+            options.printUncaughtStackTrace = true
+            val sut = UncaughtExceptionHandlerIntegration(handlerMock)
+            sut.register(mock<IHub>(), options)
+            sut.uncaughtException(mock<Thread>(), RuntimeException("This should be printed!"))
+
+            assertTrue(
+                outputStreamCaptor.toString()
+                    .contains("java.lang.RuntimeException: This should be printed!")
+            )
+            assertTrue(
+                outputStreamCaptor.toString()
+                    .contains("UncaughtExceptionHandlerIntegrationTest.kt:")
+            )
+        } finally {
+            System.setErr(standardErr)
+        }
+    }
 }