Closed Bug 1780211 Opened 2 months ago Closed 2 months ago

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

Categories

(Toolkit :: Telemetry, task, P1)

task

Tracking

()

RESOLVED FIXED
104 Branch
Tracking Status
firefox104 --- fixed

People

(Reporter: chutten, Assigned: chutten)

Details

(Whiteboard: [telemetry:fog:m?][docdays])

Attachments

(1 file)

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
Pushed by chutten@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/c30435d8f0db
Explain Telemetry enum conjugation in GIFFT docs r=perry.mcmanis DONTBUILD
Status: ASSIGNED → RESOLVED
Closed: 2 months ago
Resolution: --- → FIXED
Target Milestone: --- → 104 Branch
You need to log in before you can comment on or make changes to this bug.