Hello,

  As part of the project to report GeckoView metrics in Fenix, we have made
the `products` key required for metrics definitions in Histograms.json,
Scalars.yaml, and Events.yaml.

  The products key identifies which "products" (for a hand-wavy definition
of the word 'product') you want your probe to be recorded on and reported
through. If the `products` key for a metric doesn't contain the current
"product", then the data for that metric isn't recorded or reported.

  The full documentation is (or soon will be, if this reaches you before
the code lands either tonight or tomorrow in Nightly 70) available in the
usual places [1] [2] [3], but here's a summary of what you probably need to
know:

  For many cases, the correct value for `products` is `["firefox"]`. This
means Firefox Desktop only. Many metrics are only relevant on Firefox
Desktop, and many decisions are based only on Firefox Desktop data. If the
metric is like that, this will ensure we only collect the data we'll use.
(Mozilla Data Privacy Principle #3 - Limited data) (and we'll save memory
on every other product)

  In other cases the correct value will be the broadest one of `["firefox",
"fennec", "geckoview"]`. This will ensure that the metric is reported by
Firefox Desktop, Firefox for Android, and GeckoView-based products that use
GeckoViewTelemetryController.jsm to submit telemetry (like Focus. Don't
worry, it's okay if you don't know what this stuff is.). This is the full
list of supported products, and is the value that every currently-present
Telemetry metric has been given. This is often too broad, but without
performing a full survey we were unable to scope it more narrowly.

(( If you ever wish to narrow the population reporting your probe (by,
e.g., removing some products from the `products` key), you do not need to
seek Data Collection Review. If you wish to broaden the population (by,
e.g., adding products to the `products` key), you will require Data
Collection Review. ))

  Soon we will be adding a new acceptable value for the "products" key
(currently named "geckoview_streaming") which will enable GeckoView to pass
some Telemetry out to Glean to be reported by products like Fenix. Expect
more on that in the near future.

  If you have any questions, please do not hesitate to reach out. We can be
found on email, IRC#telemetry, and Slack#fx-metrics.

Your Friendly Neighbourhood Firefox Telemetry Team
( :chutten, :Dexter, :janerik, :gfritzsche, and :travis_ )

[1]:
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#products
[2]:
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#required-fields
[3]:
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#the-yaml-definition-file
_______________________________________________
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform

Reply via email to