⚗️ [RUM-11434] GraphQL support by rgaignault · Pull Request #3805 · DataDog/browser-sdk

rgaignault · 2025-08-28T07:02:48Z

Motivation

GraphQL calls in RUM currently appear as generic POST /graphql entries, making it hard to distinguish or debug specific operations. Mobile SDKs already support GraphQL OOTB tracking, but the Browser SDK lacked equivalent functionality. This PR introduces native GraphQL request enrichment so operations can be meaningfully identified in RUM without relying on beforeSend customization.

Changes

New configuration option :

allowedGraphQlUrls: declares which endpoints should be treated as GraphQL. Accepts strings, regex, or function matchers, with optional trackPayload.

Detects matching GraphQL requests and enriches resource events with:
operationType, operationName ,variables, payload (query body, optional via trackPayload, truncated to 32KB)

Test instructions

Checklist

Tested locally
Tested on staging
Added unit tests for this change.
Added e2e/integration tests for this change.

datadog-datadog-prod-us1 · 2025-08-28T07:06:07Z

⚠️ Tests

⚠️ Warnings

❄️ 2 New flaky tests detected

remote configuration › should resolve an option value from js variable from rum/remoteConfiguration.scenario.ts (Datadog)

createTest.ts:219:3 should resolve an option value from js variable

[Firefox] › ../lib/framework/createTest.ts:219:3 › remote configuration › should resolve an option value from js variable 

    Error: expect(received).toBe(expected) // Object.is equality

    Expected: "js-version"
    Received: undefined

       at rum/remoteConfiguration.scenario.ts:93
...

remote configuration › should resolve an option value from js variable from rum/remoteConfiguration.scenario.ts (Datadog)

createTest.ts:219:3 should resolve an option value from js variable

[Webkit] › ../lib/framework/createTest.ts:219:3 › remote configuration › should resolve an option value from js variable 

    Error: expect(received).toBe(expected) // Object.is equality

    Expected: "js-version"
    Received: undefined

       at rum/remoteConfiguration.scenario.ts:93
...

ℹ️ Info

🧪 All tests passed

🎯 Code Coverage
• Patch Coverage: 95.65%
• Total Coverage: 92.36% (+0.02%)

View detailed report

_{This comment will be updated automatically if new data arrives.

🔗 Commit SHA: d09d9fc | Docs | Was this helpful? Give us feedback!}

cit-pr-commenter · 2025-08-28T07:19:21Z

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫	𝚫%	Status
Rum	159.66 KiB	160.88 KiB	1.22 KiB	0.76%	✅
Rum Recorder	19.53 KiB	19.53 KiB	1 B	0.01%	✅
Rum Profiler	5.18 KiB	5.18 KiB	1 B	0.02%	✅
Logs	55.73 KiB	55.79 KiB	62 B	0.11%	✅
Flagging	N/A	931 B	931 B	N/A%	✅
Rum Slim	117.34 KiB	118.53 KiB	1.19 KiB	1.01%	✅
Worker	23.60 KiB	23.60 KiB	0 B	0.00%	✅

🚀 CPU Performance

Action Name	Base Average Cpu Time (ms)	Local Average Cpu Time (ms)	𝚫
addglobalcontext	0.006	0.005	-0.001
addaction	0.016	0.015	-0.001
addtiming	0.004	0.003	-0.000
adderror	0.017	0.014	-0.003
startstopsessionreplayrecording	0.001	0.001	-0.000
startview	0.004	0.004	0.000
logmessage	0.019	0.017	-0.002

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	25.73 KiB	26.09 KiB	365 B
addaction	45.73 KiB	46.49 KiB	771 B
addtiming	24.83 KiB	24.62 KiB	-218 B
adderror	52.39 KiB	50.97 KiB	-1453 B
startstopsessionreplayrecording	23.72 KiB	23.65 KiB	-70 B
startview	424.12 KiB	431.14 KiB	7.02 KiB
logmessage	41.99 KiB	42.67 KiB	697 B

🔗 RealWorld

rgaignault · 2025-09-02T11:49:44Z

/to-staging

dd-devflow-routing-codex · 2025-09-02T11:49:47Z

View all feedbacks in Devflow UI.

2025-09-02 11:49:46 UTC ℹ️ Start processing command /to-staging

2025-09-02 11:49:56 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 0s (p90)

Commit 079d9195f2 will soon be integrated into staging-36.

2025-09-02 11:50:08 UTC 🚨 Branch Integration: this merge request has conflicts which couldn't be solved automatically

We couldn't automatically merge the commit 079d9195f2 into staging-36!

To solve the conflicts directly in Github, click here to create a fix pull request.

Alternatively, you can also click here reset the integration branch or use the following Slack command: /devflow reset-branch -r browser-sdk -b staging-36

…repo /

rgaignault · 2025-09-02T12:28:40Z

/to-staging

dd-devflow-routing-codex · 2025-09-02T12:28:43Z

View all feedbacks in Devflow UI.

2025-09-02 12:28:43 UTC ℹ️ Start processing command /to-staging

2025-09-02 12:28:57 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 0s (p90)

Commit f396a31845 will soon be integrated into staging-36.

2025-09-02 12:40:47 UTC ℹ️ Branch Integration: this commit was successfully integrated

Commit f396a31845 has been merged into staging-36 in merge commit 2b96c832fb.

Check out the triggered pipeline on Gitlab 🦊

If you need to revert this integration, you can use the following command: /code revert-integration -b staging-36

Integrated commit sha: f396a31 Co-authored-by: rgaignault <[email protected]>

bcaudan · 2025-09-04T15:20:46Z

+    return {}
+  }
+
+  const graphqlMetadata = extractGraphQlMetadata(request.init?.body, graphQlConfig.trackPayload)


❓ question: ‏does anything prevent customers to use Request for their calls? cf input field of RequestCompleteEvent

Hmm I guess no but it's a readable stream so we can not access it at this time, what are you thoughts about handling this case ?

From my understanding, you can use Request with a string body, so I'd support this usage like we already do in fetchObservable.

rgaignault · 2025-09-08T09:42:13Z

/to-staging

dd-devflow-routing-codex · 2025-09-08T09:42:16Z

View all feedbacks in Devflow UI.

2025-09-08 09:42:16 UTC ℹ️ Start processing command /to-staging

2025-09-08 09:42:26 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 0s (p90)

Commit f396a31845 will soon be integrated into staging-37.

2025-09-08 09:53:07 UTC ℹ️ Branch Integration: this commit was successfully integrated

Commit f396a31845 has been merged into staging-37 in merge commit 635a7b715d.

Check out the triggered pipeline on Gitlab 🦊

If you need to revert this integration, you can use the following command: /code revert-integration -b staging-37

Integrated commit sha: f396a31 Co-authored-by: rgaignault <[email protected]>

BenoitZugmeyer

Could you add a e2e scenario?

bcaudan · 2025-09-16T10:03:22Z

💬 suggestion: ‏with the addition of the flag, it should probably be:

- ✨ [RUM-11434] GraphQL support
+ ⚗️ [RUM-11434] GraphQL support

bcaudan · 2025-09-16T14:40:37Z

+  const requestBody = request.body
+
+  return extractGraphQlMetadata(requestBody, graphQlConfig.trackPayload)


💬 suggestion: let's inline requestBody

Suggested change

const requestBody = request.body

return extractGraphQlMetadata(requestBody, graphQlConfig.trackPayload)

return extractGraphQlMetadata(request.body, graphQlConfig.trackPayload)

‏

bcaudan

Nice!

✨ Add support for GraphQL URL configuration and metadata extraction

9e68beb

rgaignault requested a review from a team as a code owner August 28, 2025 07:02

mend

70f376f

🎨 prettier

2318ebb

rgaignault mentioned this pull request Aug 28, 2025

Add support for allowed GraphQL URLs and payload tracking in telemetry configuration DataDog/rum-events-format#299

Merged

bcaudan reviewed Aug 28, 2025

View reviewed changes

update rum-event format

079d919

DataDog deleted a comment from dd-devflow-routing-codex Bot Sep 2, 2025

rgaignault added 4 commits September 2, 2025 14:07

extract function computeGraphQlData / utilize truncate function from …

686c276

…repo /

Merge branch 'main' into romanG/graph-ql-tracking

681805d

update path

de96eb7

update path

f396a31

dd-mergequeue Bot added a commit that referenced this pull request Sep 2, 2025

Integrate romanG/graph-ql-tracking (#3805) into staging-36

2b96c83

Integrated commit sha: f396a31 Co-authored-by: rgaignault <[email protected]>

dd-devflow Bot added the staging-36 label Sep 2, 2025

bcaudan reviewed Sep 4, 2025

View reviewed changes

dd-mergequeue Bot added a commit that referenced this pull request Sep 8, 2025

Integrate romanG/graph-ql-tracking (#3805) into staging-37

635a7b7

Integrated commit sha: f396a31 Co-authored-by: rgaignault <[email protected]>

dd-devflow Bot added the staging-37 label Sep 8, 2025

rgaignault added 4 commits September 8, 2025 13:22

nit and return definition

a85a3d0

remove trim for query

68cec67

✨ Add XHR support

80c4168

Merge branch 'main' into romanG/graph-ql-tracking

39fdc09

DataDog deleted a comment from bcaudan Sep 10, 2025

BenoitZugmeyer self-requested a review September 12, 2025 12:32

BenoitZugmeyer reviewed Sep 12, 2025

View reviewed changes

samcolmanetti reviewed Sep 12, 2025

View reviewed changes

Comment thread packages/rum-core/src/domain/resource/graphql.ts

rgaignault added 3 commits September 15, 2025 10:20

Add E2E test

f83758f

Add a warning for non supported Request object

ec12f1c

Add a feature flag for graphql tracking

5bcdde4

rgaignault force-pushed the romanG/graph-ql-tracking branch from 2d5939b to 5bcdde4 Compare September 15, 2025 11:35

rgaignault added 3 commits September 15, 2025 13:37

Rum event format

9b53cf1

Merge branch 'main' into romanG/graph-ql-tracking

d8ff71f

update e2e test

e35f041

bcaudan reviewed Sep 16, 2025

View reviewed changes

Comment thread packages/rum-core/src/domain/resource/graphql.ts

rgaignault changed the title ~~✨ [RUM-11434] GraphQL support~~ ⚗️ [RUM-11434] GraphQL support Sep 16, 2025

rgaignault added 3 commits September 16, 2025 13:38

🥜 Nitpick, Mapping and logic extraction

81ad1e3

🐛 Missing test and warning for all types

4590f6b

🐛 Add missing test for warning

bde794f

bcaudan reviewed Sep 16, 2025

View reviewed changes

Comment thread packages/rum-core/src/domain/resource/graphql.ts

BenoitZugmeyer reviewed Sep 16, 2025

View reviewed changes

Comment thread packages/rum-core/src/domain/resource/resourceCollection.ts Outdated

rgaignault added 4 commits September 16, 2025 15:15

🐛 Improve warning detection + remove unecesseray undefined

ccb914e

🐛 prettier

93b9f6a

🐛 update e2e expectation value for warning

7996ecb

Remove warning for saving bytes

d389992

bcaudan reviewed Sep 16, 2025

View reviewed changes

bcaudan approved these changes Sep 16, 2025

View reviewed changes

nitpick : Inline requestBody

d09d9fc

rgaignault merged commit d508410 into main Sep 16, 2025
20 checks passed

rgaignault deleted the romanG/graph-ql-tracking branch September 16, 2025 15:56

rgaignault mentioned this pull request Oct 2, 2025

🔥 [RUM-11434] Remove writable_resource_graphql experimental feature #3891

Merged

4 tasks

rgaignault mentioned this pull request Nov 12, 2025

[RUM-12424] GraphQL Documentation DataDog/documentation#32784

Merged

1 task

		const requestBody = request.body

		return extractGraphQlMetadata(requestBody, graphQlConfig.trackPayload)

Uh oh!

Conversation

rgaignault commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Test instructions

Checklist

Uh oh!

datadog-datadog-prod-us1 Bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Warnings

ℹ️ Info

Uh oh!

cit-pr-commenter Bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundles Sizes Evolution

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rgaignault commented Sep 2, 2025

Uh oh!

dd-devflow-routing-codex Bot commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rgaignault commented Sep 2, 2025

Uh oh!

dd-devflow-routing-codex Bot commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bcaudan Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

rgaignault Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bcaudan Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rgaignault commented Sep 8, 2025

Uh oh!

dd-devflow-routing-codex Bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BenoitZugmeyer left a comment

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!

bcaudan commented Sep 16, 2025 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bcaudan Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

bcaudan left a comment

Choose a reason for hiding this comment

Uh oh!

rgaignault commented Aug 28, 2025 •

edited

Loading

datadog-datadog-prod-us1 Bot commented Aug 28, 2025 •

edited

Loading

cit-pr-commenter Bot commented Aug 28, 2025 •

edited

Loading

dd-devflow-routing-codex Bot commented Sep 2, 2025 •

edited

Loading

dd-devflow-routing-codex Bot commented Sep 2, 2025 •

edited

Loading

rgaignault Sep 8, 2025 •

edited

Loading

bcaudan Sep 9, 2025 •

edited

Loading

dd-devflow-routing-codex Bot commented Sep 8, 2025 •

edited

Loading

bcaudan commented Sep 16, 2025 •

edited by atlassian Bot

Loading