# 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↩
# file, You can obtain one at http://mozilla.org/MPL/2.0/.↩

# Adding a new metric? We have docs for that!↩
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html↩

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Firefox :: Translation'

translations:
  requests_count:
    type: counter
    description: >
      The count of translation requests.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: 122

  error_rate:
    type: rate
    description: >
      The rate of failed translations requests.
    denominator_metric: translations.requests_count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: 122

  error:
    type: event
    description: >
      The specific translations error that caused a full-page translation failure.
    extra_keys:
      reason:
        type: string
        description: The reason for the error.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: 122

  translation_request:
    type: event
    description: >
      Triggers when a full-page translation request is sent.
    extra_keys:
      from_language:
        type: string
        description: The language being translated from.
      to_language:
        type: string
        description: The language being translated into.
      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:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836381
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836381
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: 122