1835502 - Add telemetry for open translations panel

Status: RESOLVED FIXED

(Firefox :: Translation, enhancement)

Description

[Erik Nordin [:nordzilla]]

As part of instrumenting translations with telemetry, we should keep track of the number of users who have interacted with the translations panel for the first time.

This patch will add a metric that increments once on only the first panel interaction for each user.

Comment 1

[Erik Nordin [:nordzilla]]

Attachment: Bug 1835502 - Add initial glean files for translations r=gregtatum!

Adds initial files for instrumenting translations with Glean
starting with a counter for translations panel first show

Comment 2

[Erik Nordin [:nordzilla]]

Attachment: Bug 1835502 - Collect metrics on open translations panel r=gregtatum!

Adds a telemetry counter for the first time the translations
panel is shown for each user.

Depends on D179297

Comment 3

[Erik Nordin [:nordzilla]]

Attachment: Bug 1835502 - Add telemetry tests for open translations panel r=gregtatum!

Depends on D179298

Comment 4

[Erik Nordin [:nordzilla]]

Attachment: data collection review request

Comment 5

[Erik Nordin [:nordzilla]]

Comment on attachment 9336635 [details]
data collection review request

>DATA REVIEW REQUEST   
>
>1) What questions will you answer with this data?
>- How many people are opening the translations panel.
>
>2) Why does Mozilla need to answer these questions?  Are there benefits for users? Do we need this information to address product or business requirements? Some example responses:
>- We want to determine how many people are interacting with the translations panel. This is the first metric I am adding to see how Glean works.
>
>3) What alternative methods did you consider to answer these questions? Why were they not sufficient?
>- No alternatives were considered. Telemetry seems to be standard practice.
>
>4) Can current instrumentation answer these questions?
>- There is no current instrumentation in this component.
>
>5) List all proposed measurements and indicate the category of data collection for each measurement, using the [Firefox data collection categories](https://wiki.mozilla.org/Data_Collection) found on the Mozilla wiki.   
>- translations.panel.open: I would guess that this falls under Necessity. We need to see how many people are interacting with this feature.
>
>6) Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
>- This collection is documented in the Glean Dictionary at https://dictionary.telemetry.mozilla.org/
>
>7) How long will this data be collected?  Choose one of the following:
>- I want to permanently monitor this data. (nordzilla)
>
>8) What populations will you measure?
>- Desktop
>
>Which release channels?
>- All current and future channels in which Translations is available.
>
>Which countries?
>- All current and future countries in which Translations is available.
>
>Which locales?
>- All current and future locales in which Translations is available.
>
>Any other filters?  Please describe in detail below.
>- No other filters
>
>9) If this data collection is default on, what is the opt-out mechanism for users?
>- These collections are Glean. The opt-out can be found in the product's preferences.
>
>10) Please provide a general description of how you will analyze this data.
>- Dashboard TBD
>
>11) Where do you intend to share the results of your analysis?
>- TBD
>
>12) Is there a third-party tool (i.e. not Glean or Telemetry) that you are proposing to use for this data collection? If so:
>- No
>

Comment 6

[Erik Nordin [:nordzilla]]

Comment on attachment 9336635 [details]
data collection review request

This say "All interactions" for 8) What populations will you measure?

But this is only Desktop. I tried to edit it, but it only shows up as a comment.

Comment 7

[Chris H-C :chutten]

Comment on attachment 9336635 [details]
data collection review request

PRELIMINARY NOTES:
Bugzilla attachments are, I think, immutable so you'd need to upload a new version and mark the old one as obsolete in order to edit it.

Also, if your collections are Glean, you may find ./mach data-review helpful for future data review requests.

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.

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

Yes. This collection can be controlled through Firefox's Preferences.

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

Yes, :nordzilla is responsible.

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

Category 2, Interaction.

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

Default on for all channels.

Does the instrumentation include the addition of any new identifiers?

No.

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

Yes.

Does the data collection use a third-party collection tool?

No.

---

Result: datareview+

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b26131e6c090
Add initial glean files for translations r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/8547db8bf00f
Add telemetry tests for open translations panel r=gregtatum

Comment 9

[Serban Stanca [:SerbanS]]

Backed out for causing linting opt failures.

• Backout link
• Push with failures
• Failure Log
• Failure line: FileToBugzillaMappingError: Missing Bugzilla component: toast - Set the BUG_COMPONENT in the moz.build file to fix the issue.

Comment 10

[Erik Nordin [:nordzilla]]

Accidentally included a text file that I was editing in VIM and was unintentionally saved/committed.

Re-landing.

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/849e6b16d8da
Add initial glean files for translations r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/f696e9aa9fec
Add telemetry tests for open translations panel r=gregtatum

Comment 12

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/849e6b16d8da
https://hg.mozilla.org/mozilla-central/rev/f696e9aa9fec