1601489 - Add locale to Glean metrics ping

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, enhancement, P1)

Description

[Ben Wu [:benwu]]

Locale is sent in the baseline ping but not in the metrics ping. It would be useful to have locale in the metrics ping so that we can easily associate locale with the metrics assuming we can get the locale for the client. Workaround is to join baseline and metrics on client_id but it would be nice to skip this step.

I'm not sure if this should be done in the sdk or on application side but according to the documentation, locale is managed by the sdk so I'm guessing here. Let me know if this is more appropriate to be done in the app.

Comment 1

[Alessio Placitelli [:Dexter]]

Hi Benjamin! Thank you for filing this.

We actually meant to do this, but it fell through the cracks. We can do this at SDK level, since it's likely needed for all products and we have the code (and tests!) for collecting that already.

Comment 2

[Beatriz Rizental [:brizental]]

Attachment: Data review request

Comment 3

[Chris H-C :chutten]

Comment on attachment 9117235 [details]
Data review request

PRELIMINARY NOTES:

"How long will this data be collected" is asking if there's an expiry mechanism in the data collection itself. In this case, I believe the collection will never expire (as with glean.baseline.duration), and the people responsible for it are the Glean Team (:dexter, :mdboom, :travis_, :chutten, :janerik, and yourself).

DATA COLLECTION REVIEW RESPONSE:

    Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes. This collection is documented in its definitions file [metrics.yaml](https://github.com/mozilla/glean/blob/master/glean-core/metrics.yaml) and the [Book of Glean](https://mozilla.github.io/glean/book/user/collected-metrics/metrics.html).

    Is there a control mechanism that allows the user to turn the data collection on and off?

Yes. The applications embedding the Glean SDK have provided user controls for turning off data collection.

    If the request is for permanent data collection, is there someone who will monitor the data over time?

Yes, the Glean Team is responsible. (:dexter, :mdboom, :travis_, :chutten, :janerik, and :brizental)

    Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 1, Technical.

    Is the data collection request for default-on or default-off?

Default on for all channels. (Though this can be narrowed per application embedding the Glean SDK)

    Does the instrumentation include the addition of any new identifiers?

No.

    Is the data collection covered by the existing Firefox privacy notice?

Yes.

    Does there need to be a check-in in the future to determine whether to renew the data?

No. This collection is permanent.

---
Result: datareview+

Comment 4

[Beatriz Rizental [:brizental]]

Upon implementing this, it became clear that the best place to put this metric is in the client_info for each ping.

That means that the metric will be part of every ping, not only baseline or metrics.

That also means that the metric will be documented in a different part of The Glean SDK Book.

All the rest is the same.

Comment 5

[Chris H-C :chutten]

(In reply to Beatriz Rizental from comment #4)

Upon implementing this, it became clear that the best place to put this metric is in the client_info for each ping.

That means that the metric will be part of every ping, not only baseline or metrics.

That also means that the metric will be documented in a different part of The Glean SDK Book.

All the rest is the same.

I confirm that it is still datareview+

Comment 6

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla-services/mozilla-pipeline-schemas/pull/482

Comment 7

[Beatriz Rizental [:brizental]]

Attachment: GitHub Pull Request