diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java index 2617cd3dfa..99b261accd 100644 --- a/sentry/src/main/java/io/sentry/SentryOptions.java +++ b/sentry/src/main/java/io/sentry/SentryOptions.java @@ -471,12 +471,19 @@ public class SentryOptions { /** Whether to enable scope persistence so the scope values are preserved if the process dies */ private boolean enableScopePersistence = true; - /** Contains a list of monitor slugs for which check-ins should not be sent. */ + /** The monitor slugs for which captured check-ins should not be sent to Sentry. */ @ApiStatus.Experimental private @Nullable List ignoredCheckIns = null; - /** Contains a list of span origins for which spans / transactions should not be created. */ + /** + * Strings or regex patterns that the name of a new span/transaction will be tested against. If + * there is a match, the span/transaction will not be created. + */ @ApiStatus.Experimental private @Nullable List ignoredSpanOrigins = null; + /** + * Strings or regex patterns that captured transaction names will be tested against. If there is a + * match, the transaction will not be sent to Sentry. + */ private @Nullable List ignoredTransactions = null; @ApiStatus.Experimental @@ -2238,11 +2245,24 @@ public void setSendModules(boolean sendModules) { this.sendModules = sendModules; } + /** + * Returns the list of strings/regex patterns the name of a new span/transaction will be tested + * against to determine whether the span/transaction shall be created. + * + * @return the list of strings or regex patterns the name of a new span/transaction will be tested + * against. If there is a match, the span/transaction will not be created. + */ @ApiStatus.Experimental public @Nullable List getIgnoredSpanOrigins() { return ignoredSpanOrigins; } + /** + * Adds an item to the list of strings/regex patterns the name of a new span/transaction will be + * tested against to determine whether the span/transaction shall be created. + * + * @param ignoredSpanOrigin the string/regex pattern + */ @ApiStatus.Experimental public void addIgnoredSpanOrigin(String ignoredSpanOrigin) { if (ignoredSpanOrigins == null) { @@ -2251,6 +2271,12 @@ public void addIgnoredSpanOrigin(String ignoredSpanOrigin) { ignoredSpanOrigins.add(new FilterString(ignoredSpanOrigin)); } + /** + * Sets the list of strings/regex patterns the name of a new span/transaction will be tested + * against to determine whether the span/transaction shall be created. + * + * @param ignoredSpanOrigins the list of strings/regex patterns + */ @ApiStatus.Experimental public void setIgnoredSpanOrigins(final @Nullable List ignoredSpanOrigins) { if (ignoredSpanOrigins == null) { @@ -2267,11 +2293,22 @@ public void setIgnoredSpanOrigins(final @Nullable List ignoredSpanOrigin } } + /** + * Returns the list of monitor slugs for which captured check-ins should not be sent to Sentry. + * + * @return the list of monitor slugs for which captured check-ins should not be sent to Sentry + */ @ApiStatus.Experimental public @Nullable List getIgnoredCheckIns() { return ignoredCheckIns; } + /** + * Adds a monitor slug to the list of slugs for which captured check-ins should not be sent to + * Sentry. + * + * @param ignoredCheckIn the monitor slug + */ @ApiStatus.Experimental public void addIgnoredCheckIn(String ignoredCheckIn) { if (ignoredCheckIns == null) { @@ -2280,6 +2317,11 @@ public void addIgnoredCheckIn(String ignoredCheckIn) { ignoredCheckIns.add(new FilterString(ignoredCheckIn)); } + /** + * Sets the list of monitor slugs for which captured check-ins should not be sent to Sentry. + * + * @param ignoredCheckIns the list of monitor slugs for which check-ins should not be sent + */ @ApiStatus.Experimental public void setIgnoredCheckIns(final @Nullable List ignoredCheckIns) { if (ignoredCheckIns == null) { @@ -2296,10 +2338,23 @@ public void setIgnoredCheckIns(final @Nullable List ignoredCheckIns) { } } + /** + * Returns the list of strings/regex patterns that captured transaction names are checked against + * to determine if a transaction shall be sent to Sentry or ignored. + * + * @return the list of strings/regex patterns that captured transaction names are checked against + * to determine if a transaction shall be sent to Sentry or ignored. + */ public @Nullable List getIgnoredTransactions() { return ignoredTransactions; } + /** + * Adds an element the list of strings/regex patterns that captured transaction names are checked + * against to determine if a transaction shall be sent to Sentry or ignored. + * + * @param ignoredTransaction the string/regex pattern + */ @ApiStatus.Experimental public void addIgnoredTransaction(String ignoredTransaction) { if (ignoredTransactions == null) { @@ -2308,6 +2363,12 @@ public void addIgnoredTransaction(String ignoredTransaction) { ignoredTransactions.add(new FilterString(ignoredTransaction)); } + /** + * Sets the list of strings/regex patterns that captured transaction names are checked against to + * determine if a transaction shall be sent to Sentry or ignored. + * + * @param ignoredTransactions the list of string/regex patterns + */ @ApiStatus.Experimental public void setIgnoredTransactions(final @Nullable List ignoredTransactions) { if (ignoredTransactions == null) {