1921514 - Implement sample-based APIs on JS for timing distributions

Status: RESOLVED FIXED

(Toolkit :: Telemetry, task, P3)

Description

[Chris H-C :chutten]

At present, timing distribution metrics don't have APIs in JS for recording times that are measured externally.

Our design philosophy with Glean has moved over the years from "Forbid everything but cases where we can assert correctness (e.g. monotonicity of timing)" to "Permit advanced users to scale back protections, trusting them to read the documentation (e.g. accepting raw durations)". This is in-line with that evolution: exposing to advanced users of the JS API some APIs for recording samples.

(( This does not invalidate our previous commentary about the duration API, though. mozJS still lacks a time duration type, so what this bug proposes is specific to sample-based APIs, not duration-based ones. Documentation warning users to keep the unit of their samples in-sync with time_unit will be deployed. ))

This bug is about implementing accumulate_single_sample and accumulate_samples for Firefox Desktop JS. Don't forget:

• Document the need to sync the samples' units to the defined time_unit on the API surfaces
• Document the new API support in the book (don't forget labeled).
• Add tests to test_Glean.js and all the rest to ensure this works in normal, JOG, GIFFT, and IPC modes.

Comment 1

[Ben Dean-Kawamura [:bdk]]

Attachment: Bug 1921514 - Timing distribution sample API, r=chutten

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a6e4ae44d85c
Timing distribution sample API, r=chutten,webidl,smaug

Comment 3

[tszentpeteri]

https://hg.mozilla.org/mozilla-central/rev/a6e4ae44d85c