1886851 - Change Nimbus Exposure Event and Add Telemetry when an Expected or Offer Translation Event Occurs

Status: RESOLVED FIXED

(Firefox for Android :: Translations, defect, P2)

Description

[Olivia Hall [:olivia]]

The exposure event for translations should occur in these cases:

• When translatable page is encountered
• When menu is opened

Right now, it happens when the user sees the dialog. The Nimbus event needs to be moved back to when the expected offer event occurs.

Comment 1

[Olivia Hall [:olivia]]

Should also probably add telemetry here too that corresponds to this Nimbus signal.

Comment 2

[Olivia Hall [:olivia]]

Attachment: OfferToTranslateDataRequest.md

Comment 3

[Roger Yang [:royang]]

Comment on attachment 9393356 [details]
OfferToTranslateDataRequest.md

DATA COLLECTION REVIEW RESPONSE:

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

Yes, through the metrics.yaml file and the Glean Dictionary.

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

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

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

[e-mail] will be responsible for monitoring the data over time

4. 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 data

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

Default on for all channels.

6. Does the instrumentation include the addition of any new identifiers?

No

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

Yes

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

No

Result: data-review+

Comment 4

[Olivia Hall [:olivia]]

Attachment: Bug 1886851 - Translations Nimbus Exposure Event and Offer TelemetryMiddleware

This patch:

• Moves the Nimbus exposure event to occur when an entry point could be shown
  • Before it was sending the event when the dialog was opened
• Adds Translations.offer_event Telemetry
• Refactors Event.translation_action to Translations.action, because we will
  be adding more telemetry under the Translations umbrella

Comment 5

[Olivia Hall [:olivia]]

Attachment: Bug 1886851 - Translations Nimbus Exposure Event and Offer Telemetry

This patch:

• Moves the Nimbus exposure event to occur when an entry point could be shown
  • Before it was sending the event when the dialog was opened
• Adds Translations.offer_event Telemetry
• Refactors Event.translation_action to Translations.action, because we will
  be adding more telemetry under the Translations umbrella

Comment 6

[Olivia Hall [:olivia]]

Attachment: OfferToTranslateDataRequestRefactor.md

In Bug 1886851, the organization of this event is slightly changed to be under the translations heading, instead of the event heading.
See Comment 7 for the right file.

Comment 7

[Olivia Hall [:olivia]]

Attachment: OfferToTranslateDataRequestRefactor.md

Includes information on refactor of earlier probe.

Comment 8

[Roger Yang [:royang]]

Comment on attachment 9394247 [details]
OfferToTranslateDataRequestRefactor.md

DATA COLLECTION REVIEW RESPONSE:

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

Yes, through the metrics.yaml file and the Glean Dictionary.

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

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

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

[e-mail] will be responsible for monitoring the data over time

4. 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 data

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

Default on for all channels.

6. Does the instrumentation include the addition of any new identifiers?

No

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

Yes

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

No

Result: data-review+

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d9858c319e84
Translations Nimbus Exposure Event and Offer Telemetry r=android-reviewers,Roger

Comment 10

[Cristina Horotan [:chorotan]]

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

Comment 11

[Mira Lobontiu (Android QA)]

Verified on the latest Fenix Nightly 127.0a1 builds from 5/8, and 5/9, using a Realme GT Master Edition (Android 13), and a Google Pixel 6 (Android 14).

The events are being generated each time the translations bottom sheet is displayed.

"category": "translations"
"name": "offer_event"
"extra":
"item": "expected"

"category": "translations"
"name": "offer_event"
"extra":
"item": "offer"