1486507 - Add Telemetry probes for Language Switcher in Preferences

Status: VERIFIED FIXED

(Firefox :: Settings UI, enhancement, P1)

Description

[Francesco Lodolo [:flod]]

Filing a bug, since we don't have one on file yet to track the addition of Telemetry probes for the new language switcher.

This document collects the initial thoughts and feedback about the kind of telemetry data we'd like to collect
https://docs.google.com/document/d/1Ad_QXuyy62WE1KX5oLUAOH0K7FW6IXX3HrLqaACPYlc

Comment 1

[Francesco Lodolo [:flod]]

@Ben
Any advice on what the next steps should be to define the data and start implementing these probes?

Comment 2

[Ben Miroglio [:bmiroglio]]

This sounds like a good candidate for event telemetry [1].

I think a logical next step is turning the bullets in that doc into well-defined events and ensuring they are feasible to capture.

Luca has been working on this for the add-on installation flow in Bug 1433335. Luca: what do you think?



[1] https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html

Comment 3

[Luca Greco [:rpl] [:luca] [:lgreco]]

Looking at the google doc attached to comment 0, it seems to me that Bug 1433335 should be able to cover the following ones:

- "Time required to download language pack"
- "Time required to download dictionaries"

which should be covered by the `addonsManager.install` events for the objects "locale" and "dictionary" with the "download_started" and "download_completed" as their "step" extra var.

Comment 4

[Mike Conley (:mconley) (:⚙️)]

I suspect this is waiting on more of the UI to be switched over to Fluent, so marking P3 for now.

Comment 5

[Mark Striemer [:mstriemer]]

The feature that this telemetry is for is being added in 64, I'll take this.

Comment 6

[Mark Striemer [:mstriemer]]

The installs are already being tracked, but we'll want to set the source in the `getInstallForURL` calls. This should involve passing an extra telemetryInfo argument to the call [1] and we can test that it's set correctly by accessing the `installTelemetryInfo` property on the addon [2].

[1] https://searchfox.org/mozilla-central/rev/1ce4e8a5601da8e744ca6eda69e782318afab54d/toolkit/components/extensions/parent/ext-management.js#200-205
[2] https://searchfox.org/mozilla-central/rev/1ce4e8a5601da8e744ca6eda69e782318afab54d/browser/components/extensions/test/browser/browser_ext_management.js#73-76

Comment 7

[Mark Striemer [:mstriemer]]

Attachment: data-review.txt

Here's the data review request document for the UI interactions. I have another document for bug 1502921 that will be category 1, if it's easier to combine them let me know.

Comment 8

[Chris H-C :chutten]

Comment on attachment 9021596 [details]
data-review.txt

Review carried in bug 1502921

Comment 9

[Mark Striemer [:mstriemer]]

Attachment: Bug 1486507 - Record telemetry for browser language changes r?rpl

Comment 10

[Chris H-C :chutten]

Comment on attachment 9021596 [details]
data-review.txt

Asking :liuche for data review. I think these events need another pair of eyes, especially when it comes to the identifiers "dialogId" and "installId"

Comment 11

[Chenxia Liu [:liuche]]

Comment on attachment 9021596 [details]
data-review.txt

1) Is there or will there be **documentation** that describes the schema for the ultimate data set available publicly, complete and accurate?
Yes, in telemetry/Events.yaml

2) Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.

Yes, can be turned off in Firefox data controls

3) If the request is for permanent data collection, is there someone who will monitor the data over time?**
No, expiration in 70

4) Using the **[category system of data types](https://wiki.mozilla.org/Firefox/Data_Collection)** on the Mozilla wiki, what collection type of data do the requested measurements fall under?  **
Type 2 - user interactions with dialog switcher

5) Is the data collection request for default-on or default-off?
default on for release (opt-out), and beta, nightly

6) Does the instrumentation include the addition of **any *new* identifiers** (whether anonymous or otherwise; e.g., username, random IDs, etc.  See the appendix for more details)?
No, collecting action names


7) Is the data collection covered by the existing Firefox privacy notice? **If unsure: escalate to legal if:**
Yes

8) Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**
Expires in 70

Comment 12

[Francesco Lodolo [:flod]]

We have an r+ but this hasn't landed yet. Also, what's the plan for bug 1502921?

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/a94a05a0a11d
Record telemetry for browser language changes r=rpl,flod,chutten

Comment 14

[Oana Pop-Rus]

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

Comment 15

[Ryan VanderMeulen [:RyanVM]]

Please nominate this for Beta uplift when you get a chance.

Comment 16

[Francesco Lodolo [:flod]]

Comment on attachment 9024797 [details]
Bug 1486507 - Record telemetry for browser language changes r?rpl

[Beta/Release Uplift Approval Request]

Feature/Bug causing the regression: None

User impact if declined: None

Is this code covered by automated tests?: Yes

Has the fix been verified in Nightly?: Yes

Needs manual test from QE?: No

If yes, steps to reproduce: QE already tested this in Nightly.

List of other uplifts needed: None

Risk to taking this patch: Low

Why is the change risky/not risky? (and alternatives if risky): Adding new Telemetry probes, no changes to existing data

String changes made/needed: None

Comment 17

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9024797 [details]
Bug 1486507 - Record telemetry for browser language changes r?rpl

[Triage Comment]
Adds Telemetry for a new feature. Approved for 65.0b11.

Comment 18

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/a902a8dcea8d

Comment 19

[Cristian Craciun]

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:66.0) Gecko/20100101 Firefox/66.0
Build ID: 20190116093310

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:65.0) Gecko/20100101 Firefox/65.0
Build ID: 20190114172331

Verified as fixed on the latest Nightly (v66) and on the latest Beta (v65b11) using macOS 10.13, Ubuntu 18.04, Windows 10 and Windows 7.