1685406 - Implement the proposed Glean Interface for Firefox Telemetry (GIFFT)

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Chris H-C :chutten]

Following the design proposed in bug 1681812 (proposal doc), implement the mirroring of Glean Metric Type API calls in C++ and JS to Telemetry APIs when the metrics have telemetry mirrors specified in their definitions in metrics.yaml.

Work will include:

• Augmenting glean_parser to accept telemetry_mirror string fields and verify the mirrored metrics have a lifetime of ping
• Adding the new Glean Metric ID -> Histogram/Scalar/Event ID maps/switchblocks to the glean_parser C++ code generator
• Augmenting each Glean Metric Type in the MLA (toolkit/components/glean/bindings/private/) to check if there's a mirror and, if so, call the appropriate Telemetry APIs
  • Be careful about processes here.
• Tests
• Documentation in-tree, including a conversion guide
  • Be sure to highlight that this is a temporary measure to get us through Migration

Comment 1

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/glean_parser/pull/275

Comment 2

[Chris H-C :chutten]

Additional requirement: Due to bug 1670261 stalled due to new gecko+nimbus+a-s+glean megazord proposal, this should also provide an ability to instrument using Glean APIs in C++/JS without Glean actually being present in the build. (Glean No-op or GNop)

As a result C++ and JS APIs and generated metrics will be unconditionally present in Gecko.

Comment 3

[Chris H-C :chutten]

Attachment: Bug 1685406 - Fix incorrect comment. r?janerik!

Comment 4

[Chris H-C :chutten]

Attachment: Bug 1685406 - Move EventExtraEntry to Telemetry.h r?janerik!

Depends on D109624

Comment 5

[Chris H-C :chutten]

Attachment: Bug 1685406 - Correct some now-incorrect FOG IPC docs on testing r?janerik!

Depends on D109625

Comment 6

[Chris H-C :chutten]

Attachment: Bug 1685406 - Clarify how new Glean metric types should architect themselves in FOG's MLA r?janerik!

Depends on D109626

Comment 7

[Chris H-C :chutten]

Attachment: Bug 1685406 - Glean Interface For Firefox Telemetry (GIFFT) r?janerik!

I tried my best to keep this self-contained so it'll be easy to remove.

Notes:

• For all three Telemetry probe types we must generate new headers
  that map from metric id to mirrored probe id.
• For events, note that we must generate a second file because of
  our strongly-typed enum class extra event keys in the C++ FOG
  Event API.
• This is intended to work in situations where there is no Glean.
  This meant rewriting a few APIs to return monotonically-increasing
  ids instead of 0 in the event there is no SDK around to generate them.

Depends on D109627

Comment 8

[Chris H-C :chutten]

Attachment: Bug 1685406 - Add regression suite for GIFFT codegen. r?janerik!

Depends on D109628

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/279347edf165
Fix incorrect comment. r=janerik
https://hg.mozilla.org/integration/autoland/rev/96f79e770e74
Move EventExtraEntry to Telemetry.h r=janerik
https://hg.mozilla.org/integration/autoland/rev/ae94785c583d
Correct some now-incorrect FOG IPC docs on testing r=janerik
https://hg.mozilla.org/integration/autoland/rev/e2c7170587f0
Clarify how new Glean metric types should architect themselves in FOG's MLA r=janerik
https://hg.mozilla.org/integration/autoland/rev/6f6bf921bdc8
Glean Interface For Firefox Telemetry (GIFFT) r=janerik
https://hg.mozilla.org/integration/autoland/rev/261f77f6af13
Add regression suite for GIFFT codegen. r=janerik

Comment 10

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/279347edf165
https://hg.mozilla.org/mozilla-central/rev/96f79e770e74
https://hg.mozilla.org/mozilla-central/rev/ae94785c583d
https://hg.mozilla.org/mozilla-central/rev/e2c7170587f0
https://hg.mozilla.org/mozilla-central/rev/6f6bf921bdc8
https://hg.mozilla.org/mozilla-central/rev/261f77f6af13