address comments, add tests, add entry to CHANGELOG.md

lcian · lcian · commit 82b9faf46d4d · 2025-01-22T14:09:29.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+### Features
+
+- Add `options.ignoreExceptions` to filter out exceptions that match a certain String or Regex ([#4083](https://github.com/getsentry/sentry-java/pull/4083))
+  - Can be set in `sentry.properties`, e.g. `ignored-exceptions=java.lang.RuntimeException,io.sentry..*`
+  - Can be set in environment variables, e.g. `SENTRY_IGNORED_EXCEPTIONS=java.lang.RuntimeException,io.sentry..*`
+  - For Spring Boot, it can be set in `application.properties`, e.g. `sentry.ignored-exceptions=java.lang.RuntimeException,io.sentry..*`
+
+## 8.0.0
+
+### Summary
+
 Version 8 of the Sentry Android/Java SDK brings a variety of features and fixes. The most notable changes are:
 
 - `Hub` has been replaced by `Scopes`
diff --git a/sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt b/sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt
@@ -174,6 +174,7 @@ class SentryAutoConfigurationTest {
             "sentry.enabled=false",
             "sentry.send-modules=false",
             "sentry.ignored-checkins=slug1,slugB",
+            "sentry.ignored-exceptions=com.some.Exception,io.sentry..*",
             "sentry.ignored-transactions=transactionName1,transactionNameB",
             "sentry.enable-backpressure-handling=false",
             "sentry.enable-spotlight=true",
@@ -215,6 +216,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.isEnabled).isEqualTo(false)
             assertThat(options.isSendModules).isEqualTo(false)
             assertThat(options.ignoredCheckIns).containsOnly(FilterString("slug1"), FilterString("slugB"))
+            assertThat(options.ignoredExceptions).containsOnly(FilterString("com.some.Exception"), FilterString("io.sentry..*"))
             assertThat(options.ignoredTransactions).containsOnly(FilterString("transactionName1"), FilterString("transactionNameB"))
             assertThat(options.isEnableBackpressureHandling).isEqualTo(false)
             assertThat(options.isForceInit).isEqualTo(true)
diff --git a/sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt b/sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt
@@ -173,6 +173,7 @@ class SentryAutoConfigurationTest {
             "sentry.enabled=false",
             "sentry.send-modules=false",
             "sentry.ignored-checkins=slug1,slugB",
+            "sentry.ignored-exceptions=com.some.Exception,io.sentry..*",
             "sentry.ignored-transactions=transactionName1,transactionNameB",
             "sentry.enable-backpressure-handling=false",
             "sentry.enable-spotlight=true",
@@ -214,6 +215,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.isEnabled).isEqualTo(false)
             assertThat(options.isSendModules).isEqualTo(false)
             assertThat(options.ignoredCheckIns).containsOnly(FilterString("slug1"), FilterString("slugB"))
+            assertThat(options.ignoredExceptions).containsOnly(FilterString("com.some.Exception"), FilterString("io.sentry..*"))
             assertThat(options.ignoredTransactions).containsOnly(FilterString("transactionName1"), FilterString("transactionNameB"))
             assertThat(options.isEnableBackpressureHandling).isEqualTo(false)
             assertThat(options.isForceInit).isEqualTo(true)
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -6061,6 +6061,7 @@ public final class io/sentry/util/EventProcessorUtils {
 public final class io/sentry/util/ExceptionUtils {
 	public fun <init> ()V
 	public static fun findRootCause (Ljava/lang/Throwable;)Ljava/lang/Throwable;
+	public static fun isIgnored (Ljava/util/Set;Ljava/util/List;Ljava/lang/Throwable;)Z
 }
 
 public final class io/sentry/util/FileUtils {
diff --git a/sentry/src/main/java/io/sentry/ExternalOptions.java b/sentry/src/main/java/io/sentry/ExternalOptions.java
@@ -128,9 +128,7 @@ public final class ExternalOptions {
     }
     options.setIdleTimeout(propertiesProvider.getLongProperty("idle-timeout"));
 
-    for (final String pattern : propertiesProvider.getList("ignored-exceptions")) {
-      options.addIgnoredException(pattern);
-    }
+    options.setIgnoredExceptions(propertiesProvider.getList("ignored-exceptions"));
 
     options.setEnabled(propertiesProvider.getBooleanProperty("enabled"));
 
diff --git a/sentry/src/main/java/io/sentry/SentryClient.java b/sentry/src/main/java/io/sentry/SentryClient.java
@@ -11,12 +11,7 @@
 import io.sentry.protocol.SentryTransaction;
 import io.sentry.transport.ITransport;
 import io.sentry.transport.RateLimiter;
-import io.sentry.util.CheckInUtils;
-import io.sentry.util.HintUtils;
-import io.sentry.util.Objects;
-import io.sentry.util.Random;
-import io.sentry.util.SentryRandom;
-import io.sentry.util.TracingUtils;
+import io.sentry.util.*;
 import java.io.Closeable;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -103,42 +98,21 @@ private boolean shouldApplyScopeData(final @NotNull CheckIn event, final @NotNul
 
     if (event != null) {
       final Throwable eventThrowable = event.getThrowable();
-      if (eventThrowable != null) {
-        if (options.containsIgnoredExceptionForType(eventThrowable)) {
-          options
-              .getLogger()
-              .log(
-                  SentryLevel.DEBUG,
-                  "Event was dropped as the exception %s is ignored",
-                  eventThrowable.getClass());
-          options
-              .getClientReportRecorder()
-              .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
-          return SentryId.EMPTY_ID;
-        }
-
-        final List<FilterString> ignoredExceptions = options.getIgnoredExceptions();
-        if (ignoredExceptions != null) {
-          final String throwableClassName = eventThrowable.getClass().getCanonicalName();
-          if (throwableClassName != null) {
-            for (final FilterString filter : ignoredExceptions) {
-              if (filter.getFilterString().equals(throwableClassName)
-                  || filter.matches(throwableClassName)) {
-                options
-                    .getLogger()
-                    .log(
-                        SentryLevel.DEBUG,
-                        "Event was dropped as the exception %s matches the ignoreExceptions filter pattern %s",
-                        throwableClassName,
-                        filter.getFilterString());
-                options
-                    .getClientReportRecorder()
-                    .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
-                return SentryId.EMPTY_ID;
-              }
-            }
-          }
-        }
+      if (eventThrowable != null
+          && ExceptionUtils.isIgnored(
+              options.getIgnoredExceptionsForType(),
+              options.getIgnoredExceptions(),
+              eventThrowable)) {
+        options
+            .getLogger()
+            .log(
+                SentryLevel.DEBUG,
+                "Event was dropped as the exception %s is ignored",
+                eventThrowable.getClass());
+        options
+            .getClientReportRecorder()
+            .recordLostEvent(DiscardReason.EVENT_PROCESSOR, DataCategory.Error);
+        return SentryId.EMPTY_ID;
       }
     }
 
diff --git a/sentry/src/main/java/io/sentry/util/ExceptionUtils.java b/sentry/src/main/java/io/sentry/util/ExceptionUtils.java
@@ -1,7 +1,11 @@
 package io.sentry.util;
 
+import io.sentry.FilterString;
+import java.util.List;
+import java.util.Set;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 @ApiStatus.Internal
 public final class ExceptionUtils {
@@ -20,4 +24,42 @@ public final class ExceptionUtils {
     }
     return rootCause;
   }
+
+  /** Checks if an exception has been ignored. */
+  @ApiStatus.Internal
+  public static @NotNull boolean isIgnored(
+      final @NotNull Set<Class<? extends Throwable>> ignoredExceptionsForType,
+      final @Nullable List<FilterString> ignoredExceptions,
+      final @NotNull Throwable throwable) {
+    if (throwable == null) {
+      return false;
+    }
+
+    final Class<? extends Throwable> throwableClass = throwable.getClass();
+    if (ignoredExceptionsForType.contains(throwableClass)) {
+      return true;
+    }
+
+    if (ignoredExceptions == null || ignoredExceptions.isEmpty()) {
+      return false;
+    }
+    final String throwableClassName = throwableClass.getCanonicalName();
+    if (throwableClassName == null) {
+      return false;
+    }
+
+    for (final FilterString filter : ignoredExceptions) {
+      if (filter.getFilterString().equals(throwableClassName)) {
+        return true;
+      }
+    }
+
+    for (final FilterString filter : ignoredExceptions) {
+      if (filter.matches(throwableClassName)) {
+        return true;
+      }
+    }
+
+    return false;
+  }
 }
diff --git a/sentry/src/test/java/io/sentry/SentryClientTest.kt b/sentry/src/test/java/io/sentry/SentryClientTest.kt
@@ -32,6 +32,7 @@ import org.junit.rules.TemporaryFolder
 import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.argumentCaptor
+import org.mockito.kotlin.atLeast
 import org.mockito.kotlin.check
 import org.mockito.kotlin.doAnswer
 import org.mockito.kotlin.eq
@@ -1792,6 +1793,15 @@ class SentryClientTest {
         verify(fixture.transport).send(any(), anyOrNull())
     }
 
+    @Test
+    fun `when ignoredExceptionsForType and ignoredExceptions are not explicitly specified, capturing event sends exceptions`() {
+        val sut = fixture.getSut()
+        sut.captureException(IllegalStateException())
+        class MyException(message: String) : Exception(message)
+        sut.captureException(MyException("hello"))
+        verify(fixture.transport, atLeast(2)).send(any(), anyOrNull())
+    }
+
     @Test
     fun `screenshot is added to the envelope from the hint`() {
         val sut = fixture.getSut()

Original file line number	Diff line number	Diff line change
`@@ -6061,6 +6061,7 @@ public final class io/sentry/util/EventProcessorUtils {`
`6061`	`6061`	`public final class io/sentry/util/ExceptionUtils {`
`6062`	`6062`	`public fun <init> ()V`
`6063`	`6063`	`public static fun findRootCause (Ljava/lang/Throwable;)Ljava/lang/Throwable;`
	`6064`	`+ public static fun isIgnored (Ljava/util/Set;Ljava/util/List;Ljava/lang/Throwable;)Z`
`6064`	`6065`	`}`
`6065`	`6066`
`6066`	`6067`	`public final class io/sentry/util/FileUtils {`
Original file line number	Diff line number	Diff line change
`@@ -128,9 +128,7 @@ public final class ExternalOptions {`
`128`	`128`	`}`
`129`	`129`	`options.setIdleTimeout(propertiesProvider.getLongProperty("idle-timeout"));`
`130`	`130`
`131`		`- for (final String pattern : propertiesProvider.getList("ignored-exceptions")) {`
`132`		`- options.addIgnoredException(pattern);`
`133`		`- }`
	`131`	`+ options.setIgnoredExceptions(propertiesProvider.getList("ignored-exceptions"));`
`134`	`132`
`135`	`133`	`options.setEnabled(propertiesProvider.getBooleanProperty("enabled"));`
`136`	`134`