RUM-13441: [Cronet] Migrating okHttp to new instrumentation API by satween · Pull Request #3180 · DataDog/dd-sdk-android

satween · 2026-02-16T22:10:04Z

What does this PR do?

Moves OkHttp instrumentation to the new networking-library agnostic approach.
Introduces a new plugin-based instrumentation API for OkHttp network monitoring, replacing the legacy DatadogInterceptor/TracingInterceptor/DatadogEventListener
approach (all classes kept for the backward compatibility)
with a single unified entry point:

OkHttpClient.Builder()
  .configureDatadogInstrumentation(
      rumInstrumentationConfiguration = RumNetworkInstrumentationConfiguration(),
      apmInstrumentationConfiguration = ApmNetworkInstrumentationConfiguration(tracedHosts)
  )
  .build()

same as for Cronet

CronetEngine.Builder()
  .configureDatadogInstrumentation(
      rumInstrumentationConfiguration = RumNetworkInstrumentationConfiguration(),
      apmInstrumentationConfiguration = ApmNetworkInstrumentationConfiguration(tracedHosts)
  )
  .build()

Motivation

Moving instrumentation logic into library-agnostic approach
Simplifying and unifying instrumentation configuration for all networking libraries
Making Datadog instrumentation configuration latest in the configuration chain

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Make sure you discussed the feature or bugfix with the maintaining team in an Issue
Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 57939dbb75

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-02-16T22:19:17Z

...khttp/src/main/kotlin/com/datadog/android/okhttp/internal/ApmInstrumentationOkHttpAdapter.kt

+        val tracingState = registry.update(call) { _, state ->
+            apmNetworkInstrumentation.onRequest(state.requestInfo)


Trace the current network request instead of cached state

RequestTracingStateRegistry.register() stores call.request() only once, but this interceptor later calls onRequest(state.requestInfo) and then proceeds with tracingState.requestInfo. For redirects/retries (where OkHttp invokes network interceptors again with a follow-up request) or when earlier interceptors mutate the request, this reuses a stale request and can drop URL/header/body changes (for example auth/signature headers), causing incorrect outbound calls and spans. The tracing state should be refreshed from chain.request() on each intercept.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-02-16T22:19:17Z

...khttp/src/main/kotlin/com/datadog/android/okhttp/internal/RumInstrumentationOkHttpAdapter.kt

+        val requestInfo = registry.get(call)?.requestInfo
+        val okHttpRequest = (requestInfo as? OkHttpRequestInfo)?.originalRequest


Proceed RUM interception with the live chain request

This adapter reads requestInfo from the registry (initialized from call.request() before application interceptors run) and then calls chain.proceed(okHttpRequest), so any request mutations made by interceptors earlier in the chain are discarded. In practice, headers or URL rewrites added upstream can be lost, which can break authenticated requests and make RUM track a different request than the one the app intended to send. Use chain.request() as the source of truth and keep the registry for correlation metadata only.

Useful? React with 👍 / 👎.

ambushwork · 2026-02-17T13:04:47Z

...in/com/datadog/android/sdk/integration/network/tests/NetworkInstrumentationComparisonTest.kt

+
+    @Test
+    @Repeat(10)
+    fun executionResultsMustBeSimilarWhen_rateLimited_okhttp_comparison() = asyncTest {


Seems the unit test is testing the equality not similarity, if so it should be renamed to executionResultsMustBeSameWhen_rateLimited_okhttp_comparison. Also, is it needed to execute 10 times on CI?

This test tests that different instrumentation produces similar spans for requests. Technically speaking they are not 100% same (because spanId and traceId are unique), but spans structure (parent-child) structure, some http attributes (status codes, url, etc) should be the same. So it's called "similar". Let me know if you think this is confusing

...khttp/src/main/kotlin/com/datadog/android/okhttp/internal/ApmInstrumentationOkHttpAdapter.kt

...id-okhttp/src/main/kotlin/com/datadog/android/okhttp/internal/RequestTracingStateRegistry.kt

.../dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPlugin.kt

...http/src/main/kotlin/com/datadog/android/okhttp/internal/RumInstrumentationTimingsCounter.kt

…changes RUM-13441: Migrating okHttp to new instrumentation API

…changes

...ndroid-rum/src/main/kotlin/com/datadog/android/rum/internal/net/RumNetworkInstrumentation.kt

.../dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPlugin.kt

...khttp/src/main/kotlin/com/datadog/android/okhttp/internal/ApmInstrumentationOkHttpAdapter.kt

...sdk-android-okhttp/src/test/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPluginTest.kt

...p/src/test/kotlin/com/datadog/android/okhttp/internal/ApmInstrumentationOkHttpAdapterTest.kt

...id-okhttp/src/main/kotlin/com/datadog/android/okhttp/internal/RequestTracingStateRegistry.kt

...p/src/test/kotlin/com/datadog/android/okhttp/internal/ApmInstrumentationOkHttpAdapterTest.kt

0xnm · 2026-03-12T10:26:43Z

.../dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPlugin.kt

+ */
+@ExperimentalTraceApi
+@ExperimentalRumApi
+fun OkHttpClient.Builder.configureDatadogInstrumentation(


We need to deprecate then existing interceptors in favor of this

I would do that after dogfooding (before release) in a separate PR

...khttp/src/test/kotlin/com/datadog/android/okhttp/internal/RequestTracingStateRegistryTest.kt

0xnm · 2026-03-12T10:52:43Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9e872b76aa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

.../dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPlugin.kt

chatgpt-codex-connector · 2026-03-12T11:00:51Z

...id-okhttp/src/main/kotlin/com/datadog/android/okhttp/internal/RequestTracingStateRegistry.kt

+        val taggedRequest = OkHttpRequestInfoBuilder(call.request().newBuilder())
+            .addTag(UUID::class.java, UUID.randomUUID())
+
+        requestTracingStateByCall[call] = RequestTracingState(taggedRequest)


Track RUM state from post-interceptor request

The registry is initialized from call.request() before application interceptors run, and in RUM-only mode there is no subsequent registry.update(...) to refresh it with the final request seen by RumInstrumentationOkHttpAdapter.startResource(...). If an upstream app interceptor rewrites method/URL/body, timing events (sendWaitForResourceTimingEvent / sendTiming) are emitted with a different resource key than the started resource, so resource timing can be dropped for those calls.

Useful? React with 👍 / 👎.

kikoveiga · 2026-03-18T14:54:37Z

...k-android-cronet/src/main/kotlin/com/datadog/android/cronet/internal/CronetRequestContext.kt

 ) {
    internal val method: String
        get() = requestParams.method
-


Is this on purpose?

kikoveiga · 2026-03-18T14:56:42Z

...sdk-android-cronet/src/test/kotlin/com/datadog/android/cronet/CronetIntegrationPluginTest.kt

        assertThat(engine.distributedTracingInstrumentation).isNull()
    }

+    @OptIn(ExperimentalRumApi::class)


Is this needed? The CronetIntegrationPluginTest class already has this annotation.

satween requested a review from a team as a code owner February 16, 2026 22:10

chatgpt-codex-connector bot reviewed Feb 16, 2026

View reviewed changes

satween force-pushed the tvaleev/feature/RUM-13974-APM-DNI branch from 8f048a3 to 91ec6c5 Compare February 17, 2026 03:18

satween force-pushed the tvaleev/feature/RUM-13441-Okhttp-instrumentation branch from 57939db to 404f86e Compare February 17, 2026 03:23

ambushwork reviewed Feb 17, 2026

View reviewed changes

aleksandr-gringauz reviewed Feb 18, 2026

View reviewed changes

.../dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/OkHttpIntegrationPlugin.kt Show resolved Hide resolved

aleksandr-gringauz reviewed Feb 18, 2026

View reviewed changes

...http/src/main/kotlin/com/datadog/android/okhttp/internal/RumInstrumentationTimingsCounter.kt Show resolved Hide resolved

satween force-pushed the tvaleev/feature/RUM-13974-APM-DNI branch 6 times, most recently from cb8e557 to 62046e7 Compare February 20, 2026 17:52

satween requested a review from a team as a code owner February 26, 2026 09:44

satween force-pushed the tvaleev/feature/RUM-13974-APM-DNI branch 2 times, most recently from d4a5e23 to f3b2a1e Compare February 27, 2026 10:55

Base automatically changed from tvaleev/feature/RUM-13974-APM-DNI to develop February 27, 2026 13:30

satween force-pushed the tvaleev/feature/RUM-13441-Okhttp-instrumentation branch from 404f86e to bc7f3d2 Compare March 2, 2026 16:44

satween added 3 commits March 11, 2026 12:20

RUM-13441: Migrating okHttp to new instrumentation API

67e75d3

RUM-13441: Migrating okHttp to new instrumentation API - Post review …

7c31073

…changes RUM-13441: Migrating okHttp to new instrumentation API

RUM-13441: Migrating okHttp to new instrumentation API - Post review …

9e872b7

…changes

satween force-pushed the tvaleev/feature/RUM-13441-Okhttp-instrumentation branch from bc7f3d2 to 9e872b7 Compare March 11, 2026 13:47

0xnm reviewed Mar 12, 2026

View reviewed changes

chatgpt-codex-connector bot reviewed Mar 12, 2026

View reviewed changes

kikoveiga reviewed Mar 18, 2026

View reviewed changes

		val tracingState = registry.update(call) { _, state ->
		apmNetworkInstrumentation.onRequest(state.requestInfo)

		val requestInfo = registry.get(call)?.requestInfo
		val okHttpRequest = (requestInfo as? OkHttpRequestInfo)?.originalRequest

Conversation

satween commented Feb 16, 2026

What does this PR do?

Review checklist (to be filled by reviewers)

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

ambushwork Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

satween Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

0xnm Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

satween Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

0xnm commented Mar 12, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector bot Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

kikoveiga Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

kikoveiga Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants