Skip to content

Commit 3c0b86d

Browse files
committed
feat(core): [Ignore HTTP Status 2] Add tracing status configuration
Add an unset option for ignored incoming server HTTP status codes and ranges. Parse external configuration without clearing existing values when all entries are invalid, and support Spring Boot binding across all supported versions. This PR only adds configuration surfaces; filtering remains unchanged. Refs #4735
1 parent a32bc6e commit 3c0b86d

10 files changed

Lines changed: 351 additions & 0 deletions

File tree

‎sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ class SentryAutoConfigurationTest {
263263
"sentry.ignored-checkins=slug1,slugB",
264264
"sentry.ignored-errors=Some error,Another .*",
265265
"sentry.ignored-transactions=transactionName1,transactionNameB",
266+
"sentry.ignored-server-http-status-codes-for-tracing=404,500-599",
266267
"sentry.enable-backpressure-handling=false",
267268
"sentry.enable-database-transaction-tracing=true",
268269
"sentry.enable-cache-tracing=true",
@@ -316,6 +317,10 @@ class SentryAutoConfigurationTest {
316317
assertThat(options.ignoredCheckIns).containsOnly("slug1", "slugB")
317318
assertThat(options.ignoredErrors).containsOnly("Some error", "Another .*")
318319
assertThat(options.ignoredTransactions).containsOnly("transactionName1", "transactionNameB")
320+
assertThat(options.ignoredServerHttpStatusCodesForTracing).hasSize(2)
321+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![0].isInRange(404)).isTrue()
322+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(500)).isTrue()
323+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(599)).isTrue()
319324
assertThat(options.isEnableBackpressureHandling).isEqualTo(false)
320325
assertThat(options.isEnableDatabaseTransactionTracing).isEqualTo(true)
321326
assertThat(options.isEnableCacheTracing).isEqualTo(true)
@@ -336,6 +341,19 @@ class SentryAutoConfigurationTest {
336341
}
337342
}
338343

344+
@Test
345+
fun `empty ignored server HTTP status codes disable the configuration`() {
346+
contextRunner
347+
.withPropertyValues(
348+
"sentry.dsn=http://key@localhost/proj",
349+
"sentry.ignored-server-http-status-codes-for-tracing=",
350+
)
351+
.run {
352+
assertThat(it.getBean(SentryProperties::class.java).ignoredServerHttpStatusCodesForTracing)
353+
.isEmpty()
354+
}
355+
}
356+
339357
@Test
340358
fun `data collection properties are applied to SentryOptions`() {
341359
contextRunner

‎sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@ class SentryAutoConfigurationTest {
266266
"sentry.ignored-checkins=slug1,slugB",
267267
"sentry.ignored-errors=Some error,Another .*",
268268
"sentry.ignored-transactions=transactionName1,transactionNameB",
269+
"sentry.ignored-server-http-status-codes-for-tracing=404,500-599",
269270
"sentry.enable-backpressure-handling=false",
270271
"sentry.enable-database-transaction-tracing=true",
271272
"sentry.enable-spotlight=true",
@@ -321,6 +322,10 @@ class SentryAutoConfigurationTest {
321322
assertThat(options.ignoredCheckIns).containsOnly("slug1", "slugB")
322323
assertThat(options.ignoredErrors).containsOnly("Some error", "Another .*")
323324
assertThat(options.ignoredTransactions).containsOnly("transactionName1", "transactionNameB")
325+
assertThat(options.ignoredServerHttpStatusCodesForTracing).hasSize(2)
326+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![0].isInRange(404)).isTrue()
327+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(500)).isTrue()
328+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(599)).isTrue()
324329
assertThat(options.isEnableBackpressureHandling).isEqualTo(false)
325330
assertThat(options.isEnableDatabaseTransactionTracing).isEqualTo(true)
326331
assertThat(options.isForceInit).isEqualTo(true)
@@ -344,6 +349,19 @@ class SentryAutoConfigurationTest {
344349
}
345350
}
346351

352+
@Test
353+
fun `empty ignored server HTTP status codes disable the configuration`() {
354+
contextRunner
355+
.withPropertyValues(
356+
"sentry.dsn=http://key@localhost/proj",
357+
"sentry.ignored-server-http-status-codes-for-tracing=",
358+
)
359+
.run {
360+
assertThat(it.getBean(SentryProperties::class.java).ignoredServerHttpStatusCodesForTracing)
361+
.isEmpty()
362+
}
363+
}
364+
347365
@Test
348366
fun `data collection properties are applied to SentryOptions`() {
349367
contextRunner

‎sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ class SentryAutoConfigurationTest {
264264
"sentry.ignored-checkins=slug1,slugB",
265265
"sentry.ignored-errors=Some error,Another .*",
266266
"sentry.ignored-transactions=transactionName1,transactionNameB",
267+
"sentry.ignored-server-http-status-codes-for-tracing=404,500-599",
267268
"sentry.enable-backpressure-handling=false",
268269
"sentry.enable-database-transaction-tracing=true",
269270
"sentry.enable-spotlight=true",
@@ -319,6 +320,10 @@ class SentryAutoConfigurationTest {
319320
assertThat(options.ignoredCheckIns).containsOnly("slug1", "slugB")
320321
assertThat(options.ignoredErrors).containsOnly("Some error", "Another .*")
321322
assertThat(options.ignoredTransactions).containsOnly("transactionName1", "transactionNameB")
323+
assertThat(options.ignoredServerHttpStatusCodesForTracing).hasSize(2)
324+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![0].isInRange(404)).isTrue()
325+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(500)).isTrue()
326+
assertThat(options.ignoredServerHttpStatusCodesForTracing!![1].isInRange(599)).isTrue()
322327
assertThat(options.isEnableBackpressureHandling).isEqualTo(false)
323328
assertThat(options.isEnableDatabaseTransactionTracing).isEqualTo(true)
324329
assertThat(options.isForceInit).isEqualTo(true)
@@ -342,6 +347,19 @@ class SentryAutoConfigurationTest {
342347
}
343348
}
344349

350+
@Test
351+
fun `empty ignored server HTTP status codes disable the configuration`() {
352+
contextRunner
353+
.withPropertyValues(
354+
"sentry.dsn=http://key@localhost/proj",
355+
"sentry.ignored-server-http-status-codes-for-tracing=",
356+
)
357+
.run {
358+
assertThat(it.getBean(SentryProperties::class.java).ignoredServerHttpStatusCodesForTracing)
359+
.isEmpty()
360+
}
361+
}
362+
345363
@Test
346364
fun `data collection properties are applied to SentryOptions`() {
347365
contextRunner

‎sentry/api/sentry.api‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,7 @@ public final class io/sentry/ExternalOptions {
567567
public fun getIgnoredCheckIns ()Ljava/util/List;
568568
public fun getIgnoredErrors ()Ljava/util/List;
569569
public fun getIgnoredExceptionsForType ()Ljava/util/Set;
570+
public fun getIgnoredServerHttpStatusCodesForTracing ()Ljava/util/List;
570571
public fun getIgnoredTransactions ()Ljava/util/List;
571572
public fun getInAppExcludes ()Ljava/util/List;
572573
public fun getInAppIncludes ()Ljava/util/List;
@@ -623,6 +624,7 @@ public final class io/sentry/ExternalOptions {
623624
public fun setIdleTimeout (Ljava/lang/Long;)V
624625
public fun setIgnoredCheckIns (Ljava/util/List;)V
625626
public fun setIgnoredErrors (Ljava/util/List;)V
627+
public fun setIgnoredServerHttpStatusCodesForTracing (Ljava/util/List;)V
626628
public fun setIgnoredTransactions (Ljava/util/List;)V
627629
public fun setMaxRequestBodySize (Lio/sentry/SentryOptions$RequestSize;)V
628630
public fun setOrgId (Ljava/lang/String;)V
@@ -710,6 +712,7 @@ public final class io/sentry/HttpStatusCodeRange {
710712
public fun <init> (I)V
711713
public fun <init> (II)V
712714
public fun isInRange (I)Z
715+
public static fun valueOf (Ljava/lang/String;)Lio/sentry/HttpStatusCodeRange;
713716
}
714717

715718
public abstract interface class io/sentry/IAppStartExtender {
@@ -3556,6 +3559,7 @@ public class io/sentry/SentryOptions : io/sentry/transport/RateLimiterConfig {
35563559
public fun getIgnoredErrorFilters ()Ljava/util/List;
35573560
public fun getIgnoredErrors ()Ljava/util/List;
35583561
public fun getIgnoredExceptionsForType ()Ljava/util/Set;
3562+
public fun getIgnoredServerHttpStatusCodesForTracing ()Ljava/util/List;
35593563
public fun getIgnoredSpanOriginFilters ()Ljava/util/List;
35603564
public fun getIgnoredSpanOrigins ()Ljava/util/List;
35613565
public fun getIgnoredTransactionFilters ()Ljava/util/List;
@@ -3729,6 +3733,7 @@ public class io/sentry/SentryOptions : io/sentry/transport/RateLimiterConfig {
37293733
public fun setIdleTimeout (Ljava/lang/Long;)V
37303734
public fun setIgnoredCheckIns (Ljava/util/List;)V
37313735
public fun setIgnoredErrors (Ljava/util/List;)V
3736+
public fun setIgnoredServerHttpStatusCodesForTracing (Ljava/util/List;)V
37323737
public fun setIgnoredSpanOrigins (Ljava/util/List;)V
37333738
public fun setIgnoredTransactions (Ljava/util/List;)V
37343739
public fun setInitPriority (Lio/sentry/InitPriority;)V

‎sentry/src/main/java/io/sentry/ExternalOptions.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public final class ExternalOptions {
5050

5151
private @Nullable List<String> ignoredCheckIns;
5252
private @Nullable List<String> ignoredTransactions;
53+
private @Nullable List<HttpStatusCodeRange> ignoredServerHttpStatusCodesForTracing;
5354

5455
private @Nullable Boolean sendModules;
5556
private @Nullable Boolean sendDefaultPii;
@@ -160,6 +161,8 @@ public final class ExternalOptions {
160161

161162
options.setIgnoredCheckIns(propertiesProvider.getListOrNull("ignored-checkins"));
162163
options.setIgnoredTransactions(propertiesProvider.getListOrNull("ignored-transactions"));
164+
options.setIgnoredServerHttpStatusCodesForTracing(
165+
parseIgnoredServerHttpStatusCodesForTracing(propertiesProvider, logger));
163166

164167
options.setEnableBackpressureHandling(
165168
propertiesProvider.getBooleanProperty("enable-backpressure-handling"));
@@ -243,6 +246,31 @@ public final class ExternalOptions {
243246
return options;
244247
}
245248

249+
private static @Nullable List<HttpStatusCodeRange> parseIgnoredServerHttpStatusCodesForTracing(
250+
final @NotNull PropertiesProvider propertiesProvider, final @NotNull ILogger logger) {
251+
final String value =
252+
propertiesProvider.getProperty("ignored-server-http-status-codes-for-tracing");
253+
if (value == null) {
254+
return null;
255+
}
256+
if (value.trim().isEmpty()) {
257+
return new ArrayList<>();
258+
}
259+
260+
final List<HttpStatusCodeRange> ranges = new ArrayList<>();
261+
for (final String token : value.split(",", -1)) {
262+
try {
263+
ranges.add(HttpStatusCodeRange.valueOf(token));
264+
} catch (IllegalArgumentException e) {
265+
logger.log(
266+
SentryLevel.WARNING,
267+
"Ignoring invalid HTTP status code range in ignored-server-http-status-codes-for-tracing: %s",
268+
token);
269+
}
270+
}
271+
return ranges.isEmpty() ? null : ranges;
272+
}
273+
246274
private static @Nullable DataCollection parseDataCollection(
247275
final @NotNull PropertiesProvider propertiesProvider) {
248276
final DataCollection dataCollection = new DataCollection();
@@ -622,6 +650,15 @@ public void setIgnoredTransactions(final @Nullable List<String> ignoredTransacti
622650
return ignoredTransactions;
623651
}
624652

653+
public void setIgnoredServerHttpStatusCodesForTracing(
654+
final @Nullable List<HttpStatusCodeRange> ignoredServerHttpStatusCodesForTracing) {
655+
this.ignoredServerHttpStatusCodesForTracing = ignoredServerHttpStatusCodesForTracing;
656+
}
657+
658+
public @Nullable List<HttpStatusCodeRange> getIgnoredServerHttpStatusCodesForTracing() {
659+
return ignoredServerHttpStatusCodesForTracing;
660+
}
661+
625662
public void setEnableBackpressureHandling(final @Nullable Boolean enableBackpressureHandling) {
626663
this.enableBackpressureHandling = enableBackpressureHandling;
627664
}

‎sentry/src/main/java/io/sentry/HttpStatusCodeRange.java‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
package io.sentry;
22

3+
import org.jetbrains.annotations.ApiStatus;
4+
import org.jetbrains.annotations.NotNull;
5+
36
/**
47
* The Http status code range. Example for a range: 400 to 499, 500 to 599, 400 to 599 The range is
58
* inclusive so the min and max is considered part of the range.
@@ -10,6 +13,9 @@ public final class HttpStatusCodeRange {
1013
public static final int DEFAULT_MIN = 500;
1114
public static final int DEFAULT_MAX = 599;
1215

16+
private static final int MIN_HTTP_STATUS_CODE = 100;
17+
private static final int MAX_HTTP_STATUS_CODE = 599;
18+
1319
private final int min;
1420
private final int max;
1521

@@ -23,6 +29,58 @@ public HttpStatusCodeRange(final int statusCode) {
2329
this.max = statusCode;
2430
}
2531

32+
/**
33+
* Parses a single HTTP status code or an inclusive range such as {@code 404} or {@code 500-599}.
34+
*
35+
* @param value the status code or range
36+
* @return the parsed range
37+
* @throws IllegalArgumentException if the value is malformed, outside 100-599, or reversed
38+
*/
39+
@ApiStatus.Internal
40+
public static @NotNull HttpStatusCodeRange valueOf(final @NotNull String value) {
41+
final String trimmedValue = value.trim();
42+
final int separatorIndex = trimmedValue.indexOf('-');
43+
if (separatorIndex < 0) {
44+
return new HttpStatusCodeRange(parseStatusCode(trimmedValue));
45+
}
46+
if (separatorIndex == 0
47+
|| separatorIndex == trimmedValue.length() - 1
48+
|| separatorIndex != trimmedValue.lastIndexOf('-')) {
49+
throw invalidRange(value);
50+
}
51+
52+
final int min = parseStatusCode(trimmedValue.substring(0, separatorIndex).trim());
53+
final int max = parseStatusCode(trimmedValue.substring(separatorIndex + 1).trim());
54+
if (min > max) {
55+
throw invalidRange(value);
56+
}
57+
return new HttpStatusCodeRange(min, max);
58+
}
59+
60+
private static int parseStatusCode(final @NotNull String value) {
61+
for (int i = 0; i < value.length(); i++) {
62+
if (!Character.isDigit(value.charAt(i))) {
63+
throw invalidRange(value);
64+
}
65+
}
66+
67+
final int statusCode;
68+
try {
69+
statusCode = Integer.parseInt(value);
70+
} catch (NumberFormatException e) {
71+
throw invalidRange(value);
72+
}
73+
if (statusCode < MIN_HTTP_STATUS_CODE || statusCode > MAX_HTTP_STATUS_CODE) {
74+
throw invalidRange(value);
75+
}
76+
return statusCode;
77+
}
78+
79+
private static @NotNull IllegalArgumentException invalidRange(final @NotNull String value) {
80+
return new IllegalArgumentException(
81+
"HTTP status code range must contain values from 100 to 599: " + value);
82+
}
83+
2684
public boolean isInRange(final int statusCode) {
2785
return statusCode >= min && statusCode <= max;
2886
}

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -598,6 +598,8 @@ public class SentryOptions implements RateLimiterConfig {
598598
*/
599599
private @Nullable List<FilterString> ignoredTransactions = null;
600600

601+
private @Nullable List<HttpStatusCodeRange> ignoredServerHttpStatusCodesForTracing = null;
602+
601603
@ApiStatus.Experimental
602604
private @NotNull IBackpressureMonitor backpressureMonitor = NoOpBackpressureMonitor.getInstance();
603605

@@ -3147,6 +3149,34 @@ public void setIgnoredTransactions(final @Nullable List<String> ignoredTransacti
31473149
}
31483150
}
31493151

3152+
/**
3153+
* Returns the HTTP status codes and inclusive ranges for which incoming server transactions are
3154+
* not sent to Sentry. An empty list disables this filter.
3155+
*
3156+
* @return the configured HTTP status code ranges, or {@code null} if unset
3157+
*/
3158+
public @Nullable List<HttpStatusCodeRange> getIgnoredServerHttpStatusCodesForTracing() {
3159+
return ignoredServerHttpStatusCodesForTracing;
3160+
}
3161+
3162+
/**
3163+
* Sets the HTTP status codes and inclusive ranges for which incoming server transactions are not
3164+
* sent to Sentry. For example, configure {@code new HttpStatusCodeRange(404)} for one status or
3165+
* {@code new HttpStatusCodeRange(500, 599)} for an inclusive range. External configuration
3166+
* accepts comma-separated codes and ranges such as {@code 404,410,500-599}. An empty list
3167+
* disables this filter.
3168+
*
3169+
* @param ignoredServerHttpStatusCodesForTracing the HTTP status code ranges, or {@code null} to
3170+
* leave the option unset
3171+
*/
3172+
public void setIgnoredServerHttpStatusCodesForTracing(
3173+
final @Nullable List<HttpStatusCodeRange> ignoredServerHttpStatusCodesForTracing) {
3174+
this.ignoredServerHttpStatusCodesForTracing =
3175+
ignoredServerHttpStatusCodesForTracing == null
3176+
? null
3177+
: new ArrayList<>(ignoredServerHttpStatusCodesForTracing);
3178+
}
3179+
31503180
/** Returns the current {@link SentryDateProvider} that is used to retrieve the current date. */
31513181
@ApiStatus.Internal
31523182
public @NotNull SentryDateProvider getDateProvider() {
@@ -3823,6 +3853,10 @@ public void merge(final @NotNull ExternalOptions options) {
38233853
final List<String> ignoredTransactions = new ArrayList<>(options.getIgnoredTransactions());
38243854
setIgnoredTransactions(ignoredTransactions);
38253855
}
3856+
if (options.getIgnoredServerHttpStatusCodesForTracing() != null) {
3857+
setIgnoredServerHttpStatusCodesForTracing(
3858+
options.getIgnoredServerHttpStatusCodesForTracing());
3859+
}
38263860
if (options.getIgnoredErrors() != null) {
38273861
final List<String> ignoredExceptions = new ArrayList<>(options.getIgnoredErrors());
38283862
setIgnoredErrors(ignoredExceptions);

0 commit comments

Comments
 (0)