Source code
Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public↩
# License, v. 2.0. If a copy of the MPL was not distributed with this↩
# Adding a new metric? We have docs for that!↩
---
$tags:
- 'Firefox :: Translation'
translations:
requests_count:
type: counter
description: >
The count of translation requests.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
error_rate:
type: rate
description: >
The rate of failed translations requests.
denominator_metric: translations.requests_count
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
error:
type: event
description: >
The specific translations error that caused a full-page translation failure.
extra_keys:
flow_id: &flow_id
type: string
description: A uuid to relate events associated with the current panel session.
first_interaction: &first_interaction
type: boolean
description: >
True if this event occurred in the user's first interaction with translations,
otherwise false.
reason:
type: string
description: The reason for the error.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
translation_request:
type: event
description: >
Triggers when a full-page translation request is sent.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
from_language:
type: string
description: The language being translated from.
to_language:
type: string
description: The language being translated to.
document_language:
type: string
description: The detected BCP-47 language tag of the document.
top_preferred_language:
type: string
description: The top preferred language for this user.
auto_translate:
type: boolean
description: >
True if this translation was triggered automatically
due to configured always-translate-language settings.
False if this translation was triggered manually.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
restore_page:
type: event
description: >
Triggers when the a restore-page event is triggered.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
translations.panel:
open:
type: event
description: >
Triggers when the translations panel is opened.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
auto_show:
type: boolean
description: Whether the panel was opened automatically or manually by the user.
view_name:
type: string
description: The type of view shown in the panel.
opened_from:
type: string
description: The method by which the translations panel was opened.
document_language:
type: string
description: The detected BCP-47 language tag of the document.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
close:
type: event
description: >
Triggers when translations panel is closed.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
open_from_language_menu:
type: event
description: >
Triggers when the from-language dropdown is opened in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
change_from_language:
type: event
description: >
Triggers when the from-language selected value is changed.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
language:
type: string
description: >
- The BCP47 language tag.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
close_from_language_menu:
type: event
description: >
Triggers when the from-language dropdown is closed in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
open_to_language_menu:
type: event
description: >
Triggers when the from-language dropdown is opened in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
change_to_language:
type: event
description: >
Triggers when the to-language selected value is changed.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
language:
type: string
description: >
- The BCP47 language tag.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
close_to_language_menu:
type: event
description: >
Triggers when the from-language dropdown is closed in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
open_settings_menu:
type: event
description: >
Triggers when the settings menu is opened in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
close_settings_menu:
type: event
description: >
Triggers when the settings menu is closed in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
cancel_button:
type: event
description: >
Triggers when the cancel button is invoked in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
change_source_language_button:
type: event
description: >
Triggers when the change-source-language button is invoked in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
dismiss_error_button:
type: event
description: >
Triggers when the dismiss-error button is invoked in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
restore_page_button:
type: event
description: >
Triggers when the restore-page button is invoked in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
translate_button:
type: event
description: >
Triggers when the translate button is invoked in the translations panel.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
always_offer_translations:
type: event
description: >
Triggers when the always-offer-translations menuitem is invoked in the translations panel seeings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
toggled_on:
type: boolean
description: >
- Whether the setting was toggled on or off.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
always_translate_language:
type: event
description: >
Triggers when the always-translate-language menuitem is invoked in the translations panel settings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
language:
type: string
description: >
- The BCP47 language tag.
toggled_on:
type: boolean
description: >
- Whether the setting was toggled on or off for this language.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
never_translate_language:
type: event
description: >
Triggers when the never-translate-language menuitem is invoked in the translations panel settings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
language:
type: string
description: >
- The BCP47 language tag.
toggled_on:
type: boolean
description: >
- Whether the setting was toggled on or off for this language.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
never_translate_site:
type: event
description: >
Triggers when the never-translate-site menuitem is invoked in the translations panel settings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
toggled_on:
type: boolean
description: >
- Whether the setting was toggled on or off for this site.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
manage_languages:
type: event
description: >
Triggers when the manage-languages menuitem is invoked in the translations panel settings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
about_translations:
type: event
description: >
Triggers when the about-translations menuitem is invoked in the translations panel settings.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never
learn_more:
type: event
description: >
Triggers when the learn-more link is invoked in the translations panel first interaction.
extra_keys:
flow_id: *flow_id
first_interaction: *first_interaction
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- translations-telemetry-alerts@mozilla.com
expires: never