1780211 - It's not clear how to determine the appropriate constant for GIFFT's telemetry_mirror

Status: RESOLVED FIXED

(Toolkit :: Telemetry, task, P1)

Description

[Chris H-C :chutten]

For GIFFT to work you need to know the C++ constant for the mirrored-to Legacy Telemetry Histogram, Scalar, or Event.

Rather unfortunately, these are all slightly different. Histograms are easy: they're just the name of the probe (e.g. GC_MS). Scalars are a little complex: they're SCREAMING_SNAKE_CASE of the category and name, with . rendered as _ (e.g. BROWSER_ENGAGEMENT_ACTIVE_TICKS for browser.engagement.active_ticks). Events are the worst: they're CamelCase of the category, method, and object delimited by _ (e.g. ContextservicesQuicksuggest_ImpressionCap_Hit for contextservices.quicksuggest#impression_cap#hit).

Each of these have good, solid reasons for being this way. But that doesn't make them easy to use.

The GIFFT docs should:

• Explain how the conjugation works differently for each type
• Explain that you can find the canonical name in objdir/toolkit/components/telemetry/Telemetry{Histogram|Scalar|Event}Enums.h

Comment 1

[Chris H-C :chutten]

Attachment: Bug 1780211 - Explain Telemetry enum conjugation in GIFFT docs r?perry.mcmanis!

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c30435d8f0db
Explain Telemetry enum conjugation in GIFFT docs r=perry.mcmanis DONTBUILD

Comment 3

[Cosmin Sabou [:CosminS]]

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