✨ [RUM-5778] Custom Vitals Collection V3

[nulrich]

Motivation

We would like to be able to report concurrent vitals with the same name and allowing better visualisations. And for better flexibility, we also want to be able to use global vitals.

Changes

Update custom vital structure:

The custom vital value is now in duration field instead of in custom object.

Update custom vital API:

startDurationVital/stopDurationVital can be used to:

• global vitals

To track performance accros components.

startDurationVital('myGlobalVital')
stopDurationVital('myGlobalVital')

• parallels vitals

To track performance of multiple instance the same components.

const ref = startDurationVital('myComponentVital')
stopDurationVital(ref)

Also introducing addDurationVital to create a vital with a custom duration and startVital values.

All those methods now have a description attribute that can be used to differentiate vitals using the same name.

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 88.63636% with 5 lines in your changes missing coverage. Please review.

Project coverage is 93.43%. Comparing base (670d5ce) to head (b14e8cf).
Report is 4 commits behind head on main.

Files	Patch %	Lines
packages/rum-core/src/boot/rumPublicApi.ts	58.33%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2929      +/-   ##
==========================================
- Coverage   93.47%   93.43%   -0.04%     
==========================================
  Files         271      271              
  Lines        7616     7636      +20     
  Branches     1696     1704       +8     
==========================================
+ Hits         7119     7135      +16     
- Misses        497      501       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cit-pr-commenter]

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫	𝚫%	Status
Rum	160.16 KiB	160.84 KiB	706 B	+0.43%	✅
Logs	55.98 KiB	55.98 KiB	0 B	0.00%	✅
Rum Slim	108.76 KiB	109.45 KiB	706 B	+0.63%	✅
Worker	25.21 KiB	25.21 KiB	0 B	0.00%	✅

🚀 CPU Performance

Action Name	Base Average Cpu Time (ms)	Local Average Cpu Time (ms)	𝚫
addglobalcontext	0.002	0.002	0.001
addaction	0.034	0.056	0.022
addtiming	0.001	0.001	0.001
adderror	0.034	0.069	0.035
startstopsessionreplayrecording	0.941	1.120	0.178
startview	1.001	1.019	0.018
logmessage	0.026	0.024	-0.002

🧠 Memory Performance

Action Name	Base Consumption Memory (bytes)	Local Consumption Memory (bytes)	𝚫 (bytes)
addglobalcontext	17.80 KiB	20.39 KiB	2.59 KiB
addaction	69.91 KiB	72.41 KiB	2.49 KiB
addtiming	15.06 KiB	16.04 KiB	999 B
adderror	83.46 KiB	84.34 KiB	900 B
startstopsessionreplayrecording	13.27 KiB	12.40 KiB	-896 B
startview	346.04 KiB	351.89 KiB	5.85 KiB
logmessage	64.91 KiB	69.96 KiB	5.05 KiB

🔗 RealWorld

[thomas-lebeau]

❓ question: If i understand correctly, custom vitals are used in web-ui already, and this PR introduce a minor breaking change (renaming details to description).
How do we plan to release this?

[amortemousque]

💬 suggestion: ‏We could give more detail on when to use the ref or the name and the limitations. Maybe say to favour refs to avoid any concurrent vital issues.

[nulrich]

Done

[amortemousque]

💬 suggestion: It would be clearer if you split this test. One when using refs and another when using names‏

[BenoitZugmeyer]

*split 😉

[nulrich]

Done

[amortemousque]

💬 suggestion: ‏You could add a test explaining what happens when creating multiple vitals with the same name and using stop with the name.

[nulrich]

Done

[BenoitZugmeyer]

💬 suggestion: ‏group vitalCollection tests together with a describe('startVitalCollection'

[nulrich]

Done

[BenoitZugmeyer]

Mmh what confused me is that we have tests for both startDurationVital and vitalCollection.startDurationVital at the same level. I would expect the module-level startDurationVital tests to be independent from tests needing startVitalCollection.