Skip to content

Add a global option to disable failed-request capture for OkHttp interceptors (including plugin-injected ones) #6731

Open

Description

@serglom21

Problem Statement

Problem Statement

SentryOkHttpInterceptor already has options to control failed-request capture (captureFailedRequests, failedRequestStatusCodes, failedRequestTargets), but they are constructor parameters, not SentryOptions (see the Android SDK options). They only work on an interceptor the app creates itself. The Sentry Android Gradle Plugin's OkHttp auto-installation also adds an interceptor, and that one cannot be configured.

When tracingInstrumentation and the OKHTTP feature are enabled, the plugin adds a SentryOkHttpInterceptor to every OkHttp client that doesn't already have one. It uses the no-arg constructor (ResponseWithInterceptorChainMethodVisitor.kt#L95-L96), so injected interceptors always run with the defaults documented for HTTP client errors: captureFailedRequests = true, failedRequestStatusCodes 500–599, failedRequestTargets .*.

Where the existing options work and where they don't:

  • Interceptor the app creates itself (manual installation): works. SentryOkHttpInterceptor(captureFailedRequests = false) is honored, and the plugin skips clients that already have a Sentry interceptor.
  • Plugin-injected interceptor: no way to set any of the options. It always uses the defaults. The Gradle plugin docs only offer turning the OkHttp instrumentation off entirely, which also removes the tracing.
  • Clients created inside third-party libraries: the app can't add its own interceptor, so these appear to get the injected defaults, since the rewrite happens in OkHttp's own call path.

As a result, every 5xx response from an instrumented OkHttp client becomes a SentryHttpClientException event, and there's no way to keep the OkHttp tracing instrumentation and turn off failed-request capture for those clients. Apps that talk to chatty backends can send a large volume of these events and exhaust their rate limit. Other SDKs expose this as a global option (Apple, Dart); Android only has the per-interceptor parameters.

This request is filed here because the fix belongs in the SDK, but the trigger is the Gradle plugin's injected interceptor. A plugin-only change would not cover manually added or Spring Boot-configured interceptors.

Current workarounds, and why they fall short:

  • Add your own SentryOkHttpInterceptor(captureFailedRequests = false) on clients you build. This can't reach clients built inside third-party libraries.
  • Drop the events in beforeSend using the OKHTTP_REQUEST / OKHTTP_RESPONSE hints. This requires manual initialization, and every app has to write and maintain its own filter.
  • options.addIgnoredExceptionForType(SentryHttpClientException::class.java) (see ignoredExceptionsForType in the Android options) drops failed-request events from every client, with no per-client or per-status-code scoping.

Solution Brainstorm

Proposal: a global kill switch in SentryOptions (the name could mirror Dart's captureFailedRequests), also settable through io.sentry.* manifest meta-data.

  • Read it at intercept time, not in the constructor, because clients can be built before Sentry.init.
  • Combine it with the per-instance value in shouldCaptureClientError (SentryOkHttpInterceptor.kt#L463-L467).
  • It covers plugin-injected, manually added, and Spring Boot auto-configured interceptors (SentryOkHttpClientBeanPostProcessor.java#L50 also uses the no-arg constructor).
  • Global status-code and target lists can follow later if there's demand, as Apple already offers (failedRequestStatusCodes, failedRequestTargets). A Gradle plugin DSL could later write the manifest key with no bytecode changes.

Alternative considered: a Gradle plugin DSL option that makes the visitor call the interceptor constructor with arguments. Not recommended: the argument constructor doesn't exist before sentry-android-okhttp 6.6.0, takes IHub up to 7.x and IScopes from 8.0.0, so the plugin would have to emit a different descriptor per SDK range. A wrong descriptor would fail with NoSuchMethodError on every OkHttp call.

Prior art: Apple exposes enableCaptureFailedRequests, failedRequestStatusCodes and failedRequestTargets as core SDK options (HTTP client errors), and Dart exposes captureFailedRequests as a global on/off option. Related: #3315, #3244, #2767, getsentry/sentry-android-gradle-plugin#650, getsentry/sentry-android-gradle-plugin#426.

Solution Brainstorm

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions