✨⚗️[RUM-11398] Add feature operation step vital APIs #3804

cy-moi · 2025-08-27T10:22:34Z

Motivation

Expose feature operation step vitals public APIs

Changes

add FeatureOperation Apis in RumPublicApi
add usage telemetry
add operation step vital in vitalCollection

Test instructions

Go on staging
Call apis from console
See events sent

Checklist

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

datadog-official · 2025-08-27T10:27:05Z

✅ Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage
• Patch Coverage: 94.44%
• Total Coverage: 92.29% (+0.00%)

View detailed report

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

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

cit-pr-commenter · 2025-08-27T10:33:34Z

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫	𝚫%	Status
Rum	157.25 KiB	158.14 KiB	910 B	0.57%	✅
Rum Recorder	19.53 KiB	19.53 KiB	0 B	0.00%	✅
Rum Profiler	5.18 KiB	5.18 KiB	0 B	0.00%	✅
Logs	55.74 KiB	55.73 KiB	-4 B	-0.01%	✅
Flagging	N/A	931 B	931 B	N/A%	✅
Rum Slim	114.99 KiB	115.82 KiB	847 B	0.72%	✅
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.005	0.008	0.002
addaction	0.019	0.024	0.004
addtiming	0.006	0.007	0.000
adderror	0.025	0.023	-0.002
startstopsessionreplayrecording	0.001	0.001	-0.000
startview	0.006	0.007	0.002
logmessage	0.029	0.021	-0.008

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	25.19 KiB	26.04 KiB	866 B
addaction	44.59 KiB	46.66 KiB	2.07 KiB
addtiming	24.83 KiB	24.81 KiB	-24 B
adderror	50.20 KiB	51.16 KiB	978 B
startstopsessionreplayrecording	24.18 KiB	24.01 KiB	-182 B
startview	422.52 KiB	431.12 KiB	8.60 KiB
logmessage	41.24 KiB	42.93 KiB	1.69 KiB

🔗 RealWorld

cy-moi · 2025-08-28T13:26:38Z

/to-staging

dd-devflow-routing-codex · 2025-08-28T13:26:42Z

View all feedbacks in Devflow UI.

2025-08-28 13:26:42 UTC ℹ️ Start processing command /to-staging

2025-08-28 13:27:02 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 15m11s (p90)

Commit 494418a708 will soon be integrated into staging-35.

2025-08-28 13:37:02 UTC ℹ️ Branch Integration: this commit was successfully integrated

Commit 494418a708 has been merged into staging-35 in merge commit 2764d2b44d.

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-35

Integrated commit sha: 494418a Co-authored-by: cy-moi <[email protected]>

mormubis · 2025-09-03T08:23:52Z

@cy-moi rebase and let's see those e2e errors are gone

BenoitZugmeyer · 2025-09-03T14:34:44Z

packages/rum-core/src/domain/vital/vitalCollection.ts

+export interface FeatureOperationOptions extends VitalOptions {
+  operationKey?: string
+}
+export interface FullFeatureOperationOptions extends FeatureOperationOptions {


suggestion: Rename FullFeatureOperationOptions to FailFeatureOperationOptions

BenoitZugmeyer · 2025-09-03T14:37:20Z

packages/rum-core/src/boot/rumPublicApi.ts

+    succeedFeatureOperation: monitor((name, options) => {
+      addTelemetryUsage({ feature: 'add-operation-step-vital', action_type: 'succeed' })
+      strategy.addOperationStepVital(name, 'end', options)
+    }),
+
+    failFeatureOperation: monitor((name, options) => {
+      addTelemetryUsage({ feature: 'add-operation-step-vital', action_type: 'fail' })
+      strategy.addOperationStepVital(name, 'end', options)
+    }),


question: how do you distinguish between succeed and fail if the user is not providing a failureReason?

Indeed, failureReason should be required.

I made the type changes (mentioned in comments below) based on this as well.

packages/rum-core/src/boot/preStartRum.ts

packages/rum-core/src/domain/vital/vitalCollection.ts

packages/rum-core/src/boot/rumPublicApi.ts

BenoitZugmeyer · 2025-09-04T13:09:51Z

packages/rum-core/src/domain/vital/vitalCollection.ts

+      vital: vitalData,
+      type: RumEventType.VITAL,
+      context,
+      ...(valueComputedBySdk && { _dd: { vital: { computed_value: true } } }),


nitpick: I'm not sure what valueComputedBySdk is, but it looks like it's always true, so maybe we can simplify?

Ah wait, this one should be false when customers use addDurationVital and compute their own values right? I think we can either remove this or we change how start or stop calling addDurationVital under the hood to pass in valueComputedBySdk.

Per discussion on slack, we are removing this value because it was only relevant to the pre-GA vital and is no longer in use.

Co-authored-by: Benoît <[email protected]>

cy-moi · 2025-09-15T09:43:24Z

/to-staging

dd-devflow-routing-codex · 2025-09-15T09:43:27Z

View all feedbacks in Devflow UI.

2025-09-15 09:43:26 UTC ℹ️ Start processing command /to-staging

2025-09-15 09:43:36 UTC ℹ️ Branch Integration: starting soon, merge expected in approximately 0s (p90)

Commit 481fce8c3e will soon be integrated into staging-38.

2025-09-15 09:54:29 UTC ℹ️ Branch Integration: this commit was successfully integrated

Commit 481fce8c3e has been merged into staging-38 in merge commit a25fe54e56.

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-38

Integrated commit sha: 481fce8 Co-authored-by: cy-moi <[email protected]>

* Add feature operation step vital apis * update sanitzation * Update API signature * Update specific types and jsdocs * Make failureReason required * Update packages/rum-core/src/boot/rumPublicApi.ts Co-authored-by: Benoît <[email protected]> * fix-comment: remove computedValueBySdk * Update rum-event-format and remove unused ff * Leverage type from schema updates --------- Co-authored-by: Benoît <[email protected]>

cy-moi force-pushed the congyao/ops-vital branch from 4001e3a to 1fe1863 Compare August 27, 2025 10:23

cy-moi force-pushed the congyao/ops-vital branch 2 times, most recently from 7cd5619 to 494418a Compare August 28, 2025 13:18

cy-moi force-pushed the congyao/ops-vital branch from 494418a to 714e048 Compare August 28, 2025 13:33

dd-mergequeue bot added a commit that referenced this pull request Aug 28, 2025

Integrate congyao/ops-vital (#3804) into staging-35

2764d2b

Integrated commit sha: 494418a Co-authored-by: cy-moi <[email protected]>

dd-devflow bot added the staging-35 label Aug 28, 2025

cy-moi marked this pull request as ready for review August 29, 2025 11:22

cy-moi requested a review from a team as a code owner August 29, 2025 11:22

cy-moi force-pushed the congyao/ops-vital branch 2 times, most recently from 17cda02 to acc2518 Compare September 2, 2025 14:55

mormubis approved these changes Sep 3, 2025

View reviewed changes

cy-moi added 4 commits September 3, 2025 16:03

Add feature operation step vital apis

4c2d3a4

update sanitzation

791ad13

Update API signature

63e8e9d

Update specific types and jsdocs

8361589

cy-moi force-pushed the congyao/ops-vital branch from acc2518 to 8361589 Compare September 3, 2025 14:03

BenoitZugmeyer reviewed Sep 3, 2025

View reviewed changes

cy-moi force-pushed the congyao/ops-vital branch from a0de1e8 to 6c1022f Compare September 3, 2025 15:25

Make failureReason required

7723cca

cy-moi force-pushed the congyao/ops-vital branch from 6c1022f to 7723cca Compare September 4, 2025 11:05

BenoitZugmeyer reviewed Sep 4, 2025

View reviewed changes

cy-moi and others added 2 commits September 4, 2025 16:43

Update packages/rum-core/src/boot/rumPublicApi.ts

179677c

Co-authored-by: Benoît <[email protected]>

fix-comment: remove computedValueBySdk

e404bf9

cy-moi force-pushed the congyao/ops-vital branch from 8560e14 to e404bf9 Compare September 4, 2025 15:10

Merge branch 'main' into congyao/ops-vital

83b2d3c

cy-moi added 2 commits September 12, 2025 11:22

Update rum-event-format and remove unused ff

9463f41

Leverage type from schema updates

481fce8

BenoitZugmeyer approved these changes Sep 15, 2025

View reviewed changes

cy-moi changed the title ~~✨ [RUM-11398] Add feature operation step vital APIs~~ ✨⚗️[RUM-11398] Add feature operation step vital APIs Sep 15, 2025

dd-mergequeue bot added a commit that referenced this pull request Sep 15, 2025

Integrate congyao/ops-vital (#3804) into staging-38

a25fe54

Integrated commit sha: 481fce8 Co-authored-by: cy-moi <[email protected]>

dd-devflow bot added the staging-38 label Sep 15, 2025

cy-moi merged commit 7f704e0 into main Sep 15, 2025
20 checks passed

cy-moi deleted the congyao/ops-vital branch September 15, 2025 11:12

✨⚗️[RUM-11398] Add feature operation step vital APIs #3804

✨⚗️[RUM-11398] Add feature operation step vital APIs #3804

Uh oh!

Conversation

cy-moi commented Aug 27, 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-official bot commented Aug 27, 2025 • edited by datadog-datadog-prod-us1 bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Bundles Sizes Evolution

Uh oh!

cy-moi commented Aug 28, 2025

Uh oh!

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

Uh oh!

Uh oh!

mormubis commented Sep 3, 2025

Uh oh!

BenoitZugmeyer Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

BenoitZugmeyer Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

cy-moi Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

cy-moi Sep 4, 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!

Uh oh!

BenoitZugmeyer Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

cy-moi Sep 4, 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!

cy-moi Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

cy-moi commented Sep 15, 2025

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cy-moi commented Aug 27, 2025 •

edited

Loading

datadog-official bot commented Aug 27, 2025 •

edited by datadog-datadog-prod-us1 bot

Loading

cit-pr-commenter bot commented Aug 27, 2025 •

edited

Loading

dd-devflow-routing-codex bot commented Aug 28, 2025 •

edited

Loading

cy-moi Sep 4, 2025 •

edited

Loading

cy-moi Sep 4, 2025 •

edited

Loading

dd-devflow-routing-codex bot commented Sep 15, 2025 •

edited

Loading