RUM-14782: Capture OkHttp Network Headers by kikoveiga · Pull Request #3204 · DataDog/dd-sdk-android

kikoveiga · 2026-02-27T10:08:57Z

What does this PR do?

Add new trackResourceHeaders public api in DatadogInterceptor.
Add new attributes for request and response headers in RumAttributes.
Extract the contents of these attributes in RumResourceScope and add them to the resource.
Business logic in ResourceHeadersExtractor.
Disable caches of networking libraries used in the sample app.

Motivation

Customers weren't able to easily capture network headers, having to do it manually (e.g., by creating custom attributes).

Additional notes

Here is an example taken from the sample app:

This is aligned with the iOS implementation:

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)

codecov-commenter · 2026-02-27T11:20:09Z

Codecov Report

❌ Patch coverage is 79.83193% with 24 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.38%. Comparing base (8d4c1d3) to head (ba09435).
⚠️ Report is 64 commits behind head on develop.

Files with missing lines	Patch %	Lines
...om/datadog/android/rum/internal/utils/StringExt.kt	39.13%	14 Missing ⚠️
...g/android/rum/resource/ResourceHeadersExtractor.kt	92.19%	4 Missing and 1 partial ⚠️
...roid/rum/internal/domain/scope/RumResourceScope.kt	72.73%	0 Missing and 3 partials ⚠️
...otlin/com/datadog/android/rum/_RumInternalProxy.kt	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3204      +/-   ##
===========================================
+ Coverage    71.29%   71.38%   +0.09%     
===========================================
  Files          938      940       +2     
  Lines        34667    34764      +97     
  Branches      5874     5893      +19     
===========================================
+ Hits         24715    24814      +99     
+ Misses        8305     8298       -7     
- Partials      1647     1652       +5

Files with missing lines	Coverage Δ
...n/com/datadog/android/okhttp/DatadogInterceptor.kt	`75.36% <100.00%> (+2.16%)`	⬆️
...otlin/com/datadog/android/rum/_RumInternalProxy.kt	`62.50% <0.00%> (-5.68%)`	⬇️
...roid/rum/internal/domain/scope/RumResourceScope.kt	`93.84% <72.73%> (+2.51%)`	⬆️
...g/android/rum/resource/ResourceHeadersExtractor.kt	`92.19% <92.19%> (ø)`
...om/datadog/android/rum/internal/utils/StringExt.kt	`39.13% <39.13%> (ø)`

... and 40 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: de599972f2

ℹ️ 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".

0xnm · 2026-03-03T10:53:32Z

    const val GRAPHQL_ERRORS: String = "_dd.graphql.errors"

+    /**
+     * The request headers of the resource. (Map<String, String>)


It is not quite clear what is expected to be key and value of this map, given that per HTTP spec headers can be repetitive, so if header name is the key, the value is List<String>. In such case how the values are joined to the single String, what is the separator?

We will use comma-separated values, as also shown in the picture of the PR description.

kikoveiga · 2026-03-04T15:24:50Z

Enforce lower-kebab-case for resource http headers rum-events-format#363

ambushwork · 2026-03-04T15:58:34Z

            getBodyLength(response, sdkCore.internalLogger),
            kind,
-            attributes + rumResourceAttributesProvider.onProvideAttributes(request, response, null)
+            attributes + headerAttributes + rumResourceAttributesProvider.onProvideAttributes(request, response, null)


onProvideAttributes functions allows to return Map<String, Any?>, but in RumResourceScope you try to cast it to Map<String,String> with as?, what will happen if the client implements rumResourceAttributesProvider but returns different stuff than Map<String,String>?

So does it make sense to change the order of the + here?

rumResourceAttributesProvider.onProvideAttributes(request, response, null) + attributes + headerAttributes

This is lowest to highest priority (left to right):

Customer attributes — can be overridden by everything

Trace/GraphQL attributes — SDK internals override customer if conflict

Header attributes — always win, since the SDK controls these keys entirely

yes, it's safer to put headerAttributes in the end to protect our header attributes not overwritten by user. also we need unit tests for this corner case.

Moved to the end for now.

As I mentioned a unit test is needed here, because this behavior can be easily broken by changing the order, so this unit test should:

fail - when the order is attributes + headerAttributes + rumResourceAttributesProvider.onProvideAttributes(request, response, null)

succeed - when the order is attributes + rumResourceAttributesProvider.onProvideAttributes(request, response, null) + headerAttributes

Added a test in the end of DatadogInterceptorTest, thank you!

ambushwork

🚀 Well done!

… ResourceHeadersExtractor

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from 4ed9e06 to a082ecb Compare February 27, 2026 10:37

This comment has been minimized.

Sign in to view

kikoveiga changed the title ~~[RUM-14782] Capture OkHttp Network Headers~~ RUM-14782: Capture OkHttp Network Headers Feb 27, 2026

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch 9 times, most recently from 998a873 to 789aef2 Compare March 2, 2026 16:34

kikoveiga self-assigned this Mar 2, 2026

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch 6 times, most recently from d99452e to de59997 Compare March 2, 2026 18:37

kikoveiga marked this pull request as ready for review March 3, 2026 10:40

kikoveiga requested review from a team as code owners March 3, 2026 10:40

chatgpt-codex-connector Bot reviewed Mar 3, 2026

View reviewed changes

Comment thread ...android-rum/src/main/kotlin/com/datadog/android/rum/internal/net/ResourceHeadersExtractor.kt Outdated

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from de59997 to 8aed174 Compare March 3, 2026 11:04

0xnm reviewed Mar 3, 2026

View reviewed changes

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch 2 times, most recently from 87abd2b to 4fdeb64 Compare March 3, 2026 15:44

ambushwork reviewed Mar 3, 2026

View reviewed changes

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from 4fdeb64 to a5ccb6e Compare March 3, 2026 16:34

kikoveiga commented Mar 4, 2026

View reviewed changes

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from 0758bf7 to 58e640a Compare March 4, 2026 15:25

ambushwork reviewed Mar 4, 2026

View reviewed changes

kikoveiga requested a review from ambushwork March 5, 2026 13:35

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from 453aba5 to 3806db0 Compare March 5, 2026 14:36

ambushwork previously approved these changes Mar 5, 2026

View reviewed changes

satween self-requested a review March 9, 2026 16:05

satween reviewed Mar 9, 2026

View reviewed changes

kikoveiga dismissed ambushwork’s stale review via db88e6c March 9, 2026 17:11

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch 2 times, most recently from 094b22f to 2dbb2d2 Compare March 10, 2026 10:34

kikoveiga requested a review from satween March 10, 2026 10:34

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from 2dbb2d2 to cb15ea2 Compare March 10, 2026 17:19

satween previously approved these changes Mar 10, 2026

View reviewed changes

0xnm requested changes Mar 11, 2026

View reviewed changes

Comment thread features/dd-sdk-android-rum/api/apiSurface Outdated

kikoveiga added 5 commits March 11, 2026 12:48

Network Headers on DatadogInterceptor

5eb2321

RUM-14782: Apply review fixes

c06b739

RUM-14782: Remove ResourceHeadersConfiguration and move everything to…

bfed803

… ResourceHeadersExtractor

RUM-14782: Update resource-schema.json

55ea0a6

RUM-14782: Move headerAttributes to the end of the attributes map

ab41a59

kikoveiga dismissed satween’s stale review via 67f72b4 March 11, 2026 12:49

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch 2 times, most recently from 67f72b4 to ca764ab Compare March 11, 2026 12:54

RUM-14782: Apply review changes

ba09435

kikoveiga force-pushed the kikoveiga/RUM-14782/capture-okhttp-network-headers branch from ca764ab to ba09435 Compare March 11, 2026 14:56

kikoveiga requested a review from 0xnm March 11, 2026 14:58

0xnm approved these changes Mar 11, 2026

View reviewed changes

kikoveiga merged commit 002ba9f into develop Mar 11, 2026
26 checks passed

kikoveiga deleted the kikoveiga/RUM-14782/capture-okhttp-network-headers branch March 11, 2026 16:01

kikoveiga mentioned this pull request Apr 21, 2026

RUM-14784: Network headers common instrumentation #3338

Merged

3 tasks

Uh oh!

Conversation

kikoveiga commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Additional notes

Review checklist (to be filled by reviewers)

Uh oh!

This comment has been minimized.

codecov-commenter commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ambushwork left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kikoveiga commented Feb 27, 2026 •

edited

Loading

codecov-commenter commented Feb 27, 2026 •

edited

Loading