# 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:
  - 'Toolkit :: Reader Mode'

readermode:
  view_on:
    type: event
    description: >
      This is recorded any time Reader Mode is turned on or off.
      This event was generated to correspond to the Legacy Telemetry event
      readermode.view#on.
    bugs: &readermode_view_bugs
      - https://bugzil.la/1689201
    data_reviews: &readermode_view_data_reviews
      - https://bugzil.la/1689201
    notification_emails: &readermode_view_emails
      - kirill@getpocket.com
      - sdowne@getpocket.com
    expires: never
    extra_keys: &readermode_view_extra
      subcategory:
        description: >
          The broad event category for this probe. E.g. navigation
        type: string
      reader_time:
        description: >
          Time spent in Reader Mode session in seconds (whole number)
        type: string
      scroll_position:
        description: >
          Percentage of window scrolled in Reader Mode (whole number)
        type: string
    telemetry_mirror: Readermode_View_On

  view_off:
    type: event
    description: >
      This is recorded any time Reader Mode is turned on or off.
      This event was generated to correspond to the Legacy Telemetry event
      readermode.view#off.
    bugs: *readermode_view_bugs
    data_reviews: *readermode_view_data_reviews
    notification_emails: *readermode_view_emails
    expires: never
    extra_keys: *readermode_view_extra
    telemetry_mirror: Readermode_View_Off

  button_click:
    type: event
    description: >
      This is recorded any time a Reader Mode button is clicked.
      This event was generated to correspond to the Legacy Telemetry event
      readermode.button#click.
    bugs:
      - https://bugzil.la/1693362
    data_reviews:
      - https://bugzil.la/1693362
    notification_emails:
      - kirill@getpocket.com
      - sdowne@getpocket.com
    expires: never
    extra_keys:
      label:
        description: >
          The type of button clicked.
        type: string
    telemetry_mirror: Readermode_Button_Click

  parse_result:
    type: custom_distribution
    description: >
      The result of trying to parse a document to show in reader view
      (0=Success, 1=Error too many elements, 2=Error in worker, 3=Error no
      article)

      This metric was generated to correspond to the Legacy Telemetry enumerated
      histogram READER_MODE_PARSE_RESULT.
    range_min: 0
    range_max: 5
    bucket_count: 6
    histogram_type: linear
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - firefox-dev@mozilla.org
      - gijs@mozilla.com
    expires: never
    telemetry_mirror: READER_MODE_PARSE_RESULT

  download_result:
    type: custom_distribution
    description: >
      The result of trying to download a document to show in reader view
      (0=Success, 1=Error XHR, 2=Error no document)

      This metric was generated to correspond to the Legacy Telemetry enumerated
      histogram READER_MODE_DOWNLOAD_RESULT.
    range_min: 0
    range_max: 5
    bucket_count: 6
    histogram_type: linear
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - firefox-dev@mozilla.org
      - gijs@mozilla.com
    expires: never
    telemetry_mirror: READER_MODE_DOWNLOAD_RESULT
