1845428 - Instrument Translations Panel With Telemetry

Status: RESOLVED FIXED

(Firefox :: Translations, enhancement, P2)

Description

[Erik Nordin [:nordzilla]]

We want to fully instrument the translations panel with telemetry such that we can determine the flow of events taken within the panel, and also anonymously determine how users are interacting with the panel the first time that they see it.

Comment 1

[Erik Nordin [:nordzilla]]

Attachment: WIP: Bug 1845428 - WIP mono-patch with console logs

Comment 2

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Clean up bug links in Translations metrics.yaml r=gregtatum!

Cleans up existing bug links by adding the comment numbers
that contain the exact data reviews.

Comment 3

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Add firstUserInteraction to TranslationsTelemetry events r=gregtatum!

Adds the notion of an event being a first-interaction
or not, to better distinguish how users interact with
the translations panel the first time they see it.

Depends on D184694

Comment 4

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Maintain flow through error states in Translations r=gregtatum!

Modifies existing telemetry events to maintain the
same flow throughout different error states that may
occur in the translations panel.

Depends on D184695

Comment 5

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry restore-page event r=gregtatum!

Adds a telemetry event for the restore-page action.

Depends on D184696

Comment 6

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry panel button events r=gregtatum!

Adds telemetry events for the button interactions
within in the Translations panel.

Depends on D184697

Comment 7

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry panel popup events r=gregtatum!

Handles telemetry events that deal with popupshown
and popuphidden in the Translations panel.

Depends on D184698

Comment 8

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry panel settings popup events r=gregtatum!

Handles telemetry events that deal with popupshown and
popuphidden for the translations settings menu invoked
from the Translations panel.

Depends on D184699

Comment 9

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry change-language events r=gregtatum!

Handles telemetry events for chaning languages within
the Translations panel.

Depends on D184700

Comment 10

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry settings events r=gregtatum!

Handles telemetry events for managing the language-
and site-based settings options from the settings
menu invoked from the Translations panel.

Depends on D184701

Comment 11

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Handle TranslationsTelemetry learn-more events r=gregtatum!

Handles telemetry events that lead to the about/learn-more
page within the Translations panel and the settings menu.

Depends on D184702

Comment 12

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Alphabetize getters in translationsPanel r=gregtatum!

Drive-by cleanup of code in translationsPanel.js

Depends on D184703

Comment 13

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Add debug logging to Translations Telemetry r=gregtatum!

Adds console logging for all of TranslationsTelemetry
that is off by default, but may be turned on in local
builds to help with debugging.

Depends on D184704

Comment 14

[Erik Nordin [:nordzilla]]

Attachment: Bug 1845428 - Add tests for new TranslationsTelemetry events r=gregtatum!

Adds tests that utilize and check all of the telemetry
events that are added in this patch stack.

Depends on D184705

Comment 15

[Erik Nordin [:nordzilla]]

Attachment: data-review-request

Comment 16

[Chris H-C :chutten]

Comment on attachment 9346110 [details]
data-review-request

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?

No. This collection will expire in Firefox 122.

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 17

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/31dab5a8e6ce
Clean up bug links in Translations metrics.yaml r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/d87a250b80b7
Add firstUserInteraction to TranslationsTelemetry events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/c3604325ed2b
Maintain flow through error states in Translations r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/80f71f0d286e
Handle TranslationsTelemetry restore-page event r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/eaaf5a61f97d
Handle TranslationsTelemetry panel button events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/2135bbe6a4d8
Handle TranslationsTelemetry panel popup events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/1305d8077717
Handle TranslationsTelemetry panel settings popup events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/1589e3f38ef8
Handle TranslationsTelemetry change-language events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/da54d21904f0
Handle TranslationsTelemetry settings events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/5a8173b2d895
Handle TranslationsTelemetry learn-more events r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/b010542e0375
Alphabetize getters in translationsPanel r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/ec4f582ab69e
Add debug logging to Translations Telemetry r=gregtatum
https://hg.mozilla.org/integration/autoland/rev/29de00271fd2
Add tests for new TranslationsTelemetry events r=gregtatum

Comment 18

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/31dab5a8e6ce
https://hg.mozilla.org/mozilla-central/rev/d87a250b80b7
https://hg.mozilla.org/mozilla-central/rev/c3604325ed2b
https://hg.mozilla.org/mozilla-central/rev/80f71f0d286e
https://hg.mozilla.org/mozilla-central/rev/eaaf5a61f97d
https://hg.mozilla.org/mozilla-central/rev/2135bbe6a4d8
https://hg.mozilla.org/mozilla-central/rev/1305d8077717
https://hg.mozilla.org/mozilla-central/rev/1589e3f38ef8
https://hg.mozilla.org/mozilla-central/rev/da54d21904f0
https://hg.mozilla.org/mozilla-central/rev/5a8173b2d895
https://hg.mozilla.org/mozilla-central/rev/b010542e0375
https://hg.mozilla.org/mozilla-central/rev/ec4f582ab69e
https://hg.mozilla.org/mozilla-central/rev/29de00271fd2