# 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/.

# This file is for Internal Telemetry Use Only.
# Please don't add anything here unless you have the permission of a
# Telemetry Module Peer.

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - "Toolkit :: Telemetry"

legacy.telemetry:
  client_id:
    type: uuid
    lifetime: application
    description: |
      The client_id according to Telemetry.
      Might not always have a value due to being too early for it to have
      loaded.
      Value may be the canary client id `c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0`
      in pings near when the data upload pref is disabled (if Telemetry gets
      to go first), or between when a client_id has been removed and when it
      has been regenerated.
      Does not need to be sent in the Glean "deletion-request" ping.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938183
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2000866
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938183
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2000866
    data_sensitivity:
      - technical
      - highly_sensitive
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never
    no_lint:
      - BASELINE_PING
    send_in_pings: &client_id_pings
      - 'metrics'
      - 'events'
      - 'newtab'
      - 'baseline'
      - 'nimbus-targeting-context'
      - 'third-party-modules'
      - 'temp-fog-initial-state'
      - 'captcha-detection'
      - 'health'
      - 'addons'
      - 'new-profile'

  profile_group_id:
    type: uuid
    lifetime: application
    description: |
      The profile_group_id according to Telemetry.
      Might not always have a value due to being too early for it to have
      loaded.
      Does not need to be sent in the Glean "deletion-request" ping.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1901263
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938183
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1901263
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938183
    data_sensitivity:
      - technical
      - highly_sensitive
    notification_emails:
      - dtownsend@mozilla.com
      - glean-team@mozilla.com
    expires: never
    no_lint:
      - BASELINE_PING
    send_in_pings: *client_id_pings

  session_id:
    type: uuid
    lifetime: application
    description: |
      Legacy Telemetry's session identifier.
      Set near startup and stable until shutdown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  session_start_date:
    type: datetime
    time_unit: hour
    lifetime: application
    description: |
      Legacy Telemetry's session start time.
      The time at which the Telemetry session started.
      Likely near to the (wall-clock) time that the application started.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

telemetry:
  data_upload_optin:
    type: boolean
    description: >
      User opted into sending Telemetry data again.
      This metric was generated to correspond to the Legacy Telemetry
      scalar telemetry.data_upload_optin.
    bugs:
      - https://bugzil.la/1445921
    data_reviews:
      - https://bugzil.la/1445921
    notification_emails:
      - jrediger@mozilla.com
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_DATA_UPLOAD_OPTIN

  archive_directories_count:
    type: custom_distribution
    description: >
      Number of directories in the archive at scan

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_ARCHIVE_DIRECTORIES_COUNT.
    range_min: 1
    range_max: 13
    bucket_count: 12
    histogram_type: linear
    unit: directories
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_DIRECTORIES_COUNT

  archive_oldest_directory_age:
    type: custom_distribution
    description: >
      The age of the oldest Telemetry archive directory in months

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_ARCHIVE_OLDEST_DIRECTORY_AGE.
    range_min: 1
    range_max: 13
    bucket_count: 12
    histogram_type: linear
    unit: months
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_OLDEST_DIRECTORY_AGE

  archive_scan_ping_count:
    type: custom_distribution
    description: >
      Number of Telemetry pings in the archive at scan

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_ARCHIVE_SCAN_PING_COUNT.
    range_min: 1
    range_max: 100000
    bucket_count: 100
    histogram_type: exponential
    unit: telemetry pings
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_SCAN_PING_COUNT

  archive_session_ping_count:
    type: counter
    description: >
      Number of Telemetry pings added to the archive during the session

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_ARCHIVE_SESSION_PING_COUNT.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_ARCHIVE_SESSION_PING_COUNT

  archive_size:
    type: memory_distribution
    description: >
      The size of the Telemetry archive (MB)

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_ARCHIVE_SIZE_MB.
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_SIZE_MB

  archive_evicted_over_quota:
    type: custom_distribution
    description: >
      Number of Telemetry pings evicted from the archive during cleanup, because
      they were over the quota

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_ARCHIVE_EVICTED_OVER_QUOTA.
    range_min: 1
    range_max: 100000
    bucket_count: 100
    histogram_type: exponential
    unit: pings
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_EVICTED_OVER_QUOTA

  archive_evicted_old_dirs:
    type: custom_distribution
    description: >
      Number of Telemetry directories evicted from the archive during cleanup,
      because they were too old

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_ARCHIVE_EVICTED_OLD_DIRS.
    range_min: 1
    range_max: 13
    bucket_count: 12
    histogram_type: linear
    unit: directories
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_EVICTED_OLD_DIRS

  archive_evicting_dirs:
    type: timing_distribution
    description: >
      Time (ms) it takes for evicting old directories

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_ARCHIVE_EVICTING_DIRS_MS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_EVICTING_DIRS_MS

  archive_checking_over_quota:
    type: timing_distribution
    description: >
      Time (ms) it takes for checking if the archive is over-quota

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_ARCHIVE_CHECKING_OVER_QUOTA_MS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_CHECKING_OVER_QUOTA_MS

  archive_evicting_over_quota:
    type: timing_distribution
    description: >
      Time (ms) it takes for evicting over-quota pings

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_ARCHIVE_EVICTING_OVER_QUOTA_MS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1162538
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_ARCHIVE_EVICTING_OVER_QUOTA_MS

  pending_load_failure_read:
    type: counter
    description: >
      Number of pending Telemetry pings that failed to load from the disk

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PENDING_LOAD_FAILURE_READ.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PENDING_LOAD_FAILURE_READ

  pending_load_failure_parse:
    type: counter
    description: >
      Number of pending Telemetry pings that failed to parse once loaded from
      the disk

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PENDING_LOAD_FAILURE_PARSE.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PENDING_LOAD_FAILURE_PARSE

  pending_pings_size:
    type: memory_distribution
    description: >
      The size of the Telemetry pending pings directory (MB). The special value
      17 is used to indicate over quota pings.

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_PENDING_PINGS_SIZE_MB.
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_PENDING_PINGS_SIZE_MB

  pending_pings_age:
    type: timing_distribution
    description: >
      The age, in days, of the pending pings.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_PENDING_PINGS_AGE.
    time_unit: day
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_PENDING_PINGS_AGE

  pending_pings_evicted_over_quota:
    type: custom_distribution
    description: >
      Number of Telemetry pings evicted from the pending pings directory during
      cleanup, because they were over the quota

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_PENDING_PINGS_EVICTED_OVER_QUOTA.
    range_min: 1
    range_max: 100000
    bucket_count: 100
    histogram_type: exponential
    unit: pings
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_PENDING_PINGS_EVICTED_OVER_QUOTA

  pending_evicting_over_quota:
    type: timing_distribution
    description: >
      Time (ms) it takes for evicting over-quota pending pings

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_PENDING_EVICTING_OVER_QUOTA_MS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_PENDING_EVICTING_OVER_QUOTA_MS

  pending_checking_over_quota:
    type: timing_distribution
    description: >
      Time (ms) it takes for checking if the pending pings are over-quota

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_PENDING_CHECKING_OVER_QUOTA_MS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_PENDING_CHECKING_OVER_QUOTA_MS

  ping_size_exceeded_send:
    type: counter
    description: >
      Number of Telemetry pings discarded before sending because they exceeded
      the maximum size

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PING_SIZE_EXCEEDED_SEND.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PING_SIZE_EXCEEDED_SEND

  ping_size_exceeded_pending:
    type: counter
    description: >
      Number of Telemetry pending pings discarded because they exceeded the
      maximum size

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PING_SIZE_EXCEEDED_PENDING.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PING_SIZE_EXCEEDED_PENDING

  ping_size_exceeded_archived:
    type: counter
    description: >
      Number of archived Telemetry pings discarded because they exceeded the
      maximum size

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PING_SIZE_EXCEEDED_ARCHIVED.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PING_SIZE_EXCEEDED_ARCHIVED

  ping_submission_waiting_clientid:
    type: counter
    description: >
      The number of pings that were submitted and had to wait for a client id
      (i.e. before it was cached or loaded from disk)

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PING_SUBMISSION_WAITING_CLIENTID.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1233986
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1233986
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PING_SUBMISSION_WAITING_CLIENTID

  discarded_pending_pings_size:
    type: memory_distribution
    description: >
      The size (MB) of the Telemetry pending pings exceeding the maximum file
      size

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_DISCARDED_PENDING_PINGS_SIZE_MB.
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_DISCARDED_PENDING_PINGS_SIZE_MB

  discarded_archived_pings_size:
    type: memory_distribution
    description: >
      The size (MB) of the Telemetry archived, compressed, pings exceeding the
      maximum file size

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_DISCARDED_ARCHIVED_PINGS_SIZE_MB.
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_DISCARDED_ARCHIVED_PINGS_SIZE_MB

  discarded_send_pings_size:
    type: memory_distribution
    description: >
      The size (MB) of the ping data submitted to Telemetry exceeding the
      maximum size

      This metric was generated to correspond to the Legacy Telemetry linear
      histogram TELEMETRY_DISCARDED_SEND_PINGS_SIZE_MB.
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_DISCARDED_SEND_PINGS_SIZE_MB

  compress:
    type: timing_distribution
    description: >
      Time taken to compress telemetry object (ms)

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_COMPRESS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_COMPRESS

  send_success:
    type: timing_distribution
    description: >
      Time needed (in ms) for a successful send of a Telemetry ping to the
      servers and getting a reply back.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_SEND_SUCCESS.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1318284
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1318284
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_SEND_SUCCESS

  send_failure:
    type: timing_distribution
    description: >
      Time needed (in ms) for a failed send of a Telemetry ping to the servers
      and getting a reply back.

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_SEND_FAILURE.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1318284
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1318284
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_SEND_FAILURE

  send_failure_type:
    type: labeled_counter
    description: >
      Counts of the different ways sending a Telemetry ping can fail.

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram TELEMETRY_SEND_FAILURE_TYPE.
    labels:
      - eOK
      - eRequest
      - eUnreachable
      - eChannelOpen
      - eRedirect
      - abort
      - timeout
      - eTooLate
      - eTerminated
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1367110
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1501303
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1367110
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1501303
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - chutten@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_SEND_FAILURE_TYPE

  send_failure_type_per_ping:
    type: dual_labeled_counter
    description: >
      Counts of the different ways sending a Telemetry ping can fail per ping
      type.

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram TELEMETRY_SEND_FAILURE_TYPE_PER_PING.
    dual_labels:
      key:
        description: Ping type.
      category:
        labels:
          - eOK
          - eRequest
          - eUnreachable
          - eChannelOpen
          - eRedirect
          - abort
          - timeout
          - eTooLate
          - eTerminated
        description: Labels of the keyed categorical legacy telemetry histogram
          TELEMETRY_SEND_FAILURE_TYPE_PER_PING.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1438896
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1438896
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - chutten@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_SEND_FAILURE_TYPE_PER_PING

  stringify:
    type: timing_distribution
    description: >
      Time to stringify telemetry object (ms)

      This metric was generated to correspond to the Legacy Telemetry
      exponential histogram TELEMETRY_STRINGIFY.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: TELEMETRY_STRINGIFY

  success:
    type: labeled_counter
    description: >
      Successful telemetry submission

      This metric was generated to correspond to the Legacy Telemetry boolean
      histogram TELEMETRY_SUCCESS.
    labels:
      - "false"
      - "true"
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_SUCCESS

  invalid_ping_type_submitted:
    type: labeled_counter
    description: >
      Count of individual invalid ping types that were submitted to Telemetry.

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_INVALID_PING_TYPE_SUBMITTED.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_INVALID_PING_TYPE_SUBMITTED

  invalid_payload_submitted:
    type: counter
    description: >
      Count of individual invalid payloads that were submitted to Telemetry.

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_INVALID_PAYLOAD_SUBMITTED.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1292226
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1292226
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_INVALID_PAYLOAD_SUBMITTED

  ping_evicted_for_server_errors:
    type: counter
    description: >
      Number of Telemetry ping files evicted due to server errors (4XX HTTP code
      received)

      This metric was generated to correspond to the Legacy Telemetry count
      histogram TELEMETRY_PING_EVICTED_FOR_SERVER_ERRORS.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - telemetry-client-dev@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_PING_EVICTED_FOR_SERVER_ERRORS

  event_ping_sent:
    type: labeled_counter
    description: >
      Number of 'event' pings sent, by reason

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram TELEMETRY_EVENT_PING_SENT.
    labels:
      - periodic
      - max
      - shutdown
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1460595
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1460595
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - chutten@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_EVENT_PING_SENT

  event_registration_error:
    type: labeled_counter
    description: >
      Number of event registration failures, by field causing the failure

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram TELEMETRY_EVENT_REGISTRATION_ERROR.
    labels:
      - Other
      - Name
      - Category
      - Method
      - Object
      - ExtraKeys
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1480204
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1480204
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - chutten@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_EVENT_REGISTRATION_ERROR

  event_recording_error:
    type: labeled_counter
    description: >
      Number of event recording failures, by type of failure

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram TELEMETRY_EVENT_RECORDING_ERROR.
    labels:
      - UnknownEvent
      - Expired
      - ExtraKey
      - Value
      - Extra
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1480204
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1480204
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - chutten@mozilla.com
    expires: never
    telemetry_mirror: h#TELEMETRY_EVENT_RECORDING_ERROR

usage:
  profile_id:
    type: uuid
    lifetime: user
    description: |
      A UUID uniquely identifying the profile,
      not shared with other telemetry data.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1926829
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1926829
    data_sensitivity:
      - technical
      - highly_sensitive
    notification_emails:
      - glean-team@mozilla.com
      - jrediger@mozilla.com
      - loines@mozilla.com
    expires: never
    send_in_pings:
      - usage-reporting
      - usage-deletion-request
      - onboarding-opt-out
  profile_group_id:
    type: uuid
    lifetime: user
    description: |
      A UUID uniquely identifying the profile group,
      not shared with other telemetry data.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944648
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944648
    data_sensitivity:
      - technical
      - highly_sensitive
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
      - jhirsch@mozilla.com
    expires: never
    send_in_pings:
      - usage-reporting
      - usage-deletion-request
      - onboarding-opt-out
  os:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The name of the operating system.
      Possible values:
      Android, iOS, Linux, Darwin, Windows,
      FreeBSD, NetBSD, OpenBSD, Solaris, Unknown
    bugs:
      - https://bugzilla.mozilla.org/1497894
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  os_version:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The user-visible version of the operating system (e.g. "1.2.3").
      If the version detection fails, this metric gets set to `Unknown`.
    bugs:
      - https://bugzilla.mozilla.org/1497894
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  windows_build_number:
    type: quantity
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The optional Windows build number, reported by Windows
      (e.g. 22000) and not set for other platforms.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1802094
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1802094
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
    unit: build_number
  windows_backup_enabled:
    type: boolean
    lifetime: application
    send_in_pings:
      - usage-reporting
    description: |
      Tracks if Windows Backup is enabled and configured to back up applications.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968600
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968600
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
  windows_user_profile_age_in_days:
    type: quantity
    unit: days
    lifetime: application
    send_in_pings:
      - usage-reporting
    description: |
        The age of the current users home folder in days.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968710
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968710
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
  app_build:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The build identifier generated by the CI system (e.g. "1234/A").
      If the value was not provided through configuration,
      this metric gets set to `Unknown`.
    bugs:
      - https://bugzilla.mozilla.org/1508305
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  app_display_version:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The user visible version string (e.g. "1.0.3").
      If the value was not provided through configuration,
      this metric gets set to `Unknown`.
    bugs:
      - https://bugzilla.mozilla.org/1508305
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1508305#c9
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  app_channel:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    description: |
      The channel the application is being distributed on.
    bugs:
      - https://bugzilla.mozilla.org/1520741
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1520741#c18
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  first_run_date:
    type: datetime
    lifetime: user
    send_in_pings:
      - usage-reporting
      - onboarding-opt-out
    time_unit: day
    description: |
      The date of the profile's first use. Set from `ProfileAge.firstUse`
    bugs:
      - https://bugzilla.mozilla.org/1525045
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1525045#c18
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  reason:
    type: string
    lifetime: ping
    send_in_pings:
      - usage-reporting
    description: |
      The reason the usage-reporting ping was sent.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1557048
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1609218#c4
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  is_default_browser:
    type: boolean
    lifetime: application
    send_in_pings:
      - usage-reporting
      - baseline
      - onboarding-opt-out
      - events
    no_lint:
      - BASELINE_PING
    description: |
      Whether Firefox is set as the default browser.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never
  distribution_id:
    type: string
    lifetime: application
    send_in_pings:
      - usage-reporting
      - baseline
      - onboarding-opt-out
    no_lint:
      - BASELINE_PING
    description: |
      The distribution id associated with the install of Firefox.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944090
    data_sensitivity:
      - technical
    notification_emails:
      - glean-team@mozilla.com
      - loines@mozilla.com
    expires: never

browser.engagement:
  session_time_including_suspend:
    type: quantity
    description: >
      The duration of the session in milliseconds, including the time the
      device was suspended.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.session_time_including_suspend.
    bugs:
      - https://bugzil.la/1205985
    data_reviews:
      - https://bugzil.la/1205985
    notification_emails:
      - padenot@mozilla.com
    expires: never
    unit: ms
    telemetry_mirror: BROWSER_ENGAGEMENT_SESSION_TIME_INCLUDING_SUSPEND

  session_time_excluding_suspend:
    type: quantity
    description: >
      The duration of the session in milliseconds, excluding the time the
      device was suspended.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.session_time_excluding_suspend.
    bugs:
      - https://bugzil.la/1205985
    data_reviews:
      - https://bugzil.la/1205985
    notification_emails:
      - padenot@mozilla.com
    expires: never
    unit: ms
    telemetry_mirror: BROWSER_ENGAGEMENT_SESSION_TIME_EXCLUDING_SUSPEND

browser.timings:
  last_shutdown:
    type: quantity
    description: >
      The time, in milliseconds, it took to complete the last shutdown. On
      successful shutdown, Telemetry saves this to disk into
      Telemetry.ShutdownTime.txt. On the next startup this is loaded and
      recorded.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.timings.last_shutdown.
    bugs:
      - https://bugzil.la/1429510
    data_reviews:
      - https://bugzil.la/1429510
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - florian@mozilla.com
    expires: never
    unit: ms

onboarding_opt_out:
  # The `onboarding-opt-out` ping does not include any info sections, and
  # therefore needs to capture experiments and rollouts independently.  This
  # data layout agrees with the `nimbus-targeting-context` ping for ease of
  # analysis.
  active_experiments:
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    expires: never
    notification_emails:
      - glean-team@mozilla.com
      - jrediger@mozilla.com
      - loines@mozilla.com
      - dberry@mozilla.com
    send_in_pings:
      - onboarding-opt-out
    description: >
      The slugs of the actively enrolled experiments.
    data_sensitivity:
      - interaction
    type: object
    structure:
      type: array
      items:
        type: string

  active_rollouts:
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    expires: never
    notification_emails:
      - glean-team@mozilla.com
      - jrediger@mozilla.com
      - loines@mozilla.com
      - dberry@mozilla.com
    send_in_pings:
      - onboarding-opt-out
    description: >
      The slugs of the actively enrolled rollouts.
    data_sensitivity:
      - interaction
    type: object
    structure:
      type: array
      items:
        type: string

  enrollments_map:
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1942194
    expires: never
    notification_emails:
      - glean-team@mozilla.com
      - jrediger@mozilla.com
      - loines@mozilla.com
      - dberry@mozilla.com
    send_in_pings:
      - onboarding-opt-out
    description: >
      Information about historic enrollments, including the branches enrolled.
    data_sensitivity:
      - technical
    type: object
    structure:
      type: array
      items:
        type: object
        properties:
          experimentSlug:
            type: string
          branchSlug:
            type: string

termsofuse:
  version:
    type: quantity
    description: >
      The version of the Terms of Use the user accepted.
    unit: version
    lifetime: application
    send_in_pings:
      - metrics
    notification_emails:
      - mviar@mozilla.com
      - omc-core@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971184
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974150
    expires: never

  date:
    type: datetime
    description: >
      The timestamp when the user accepted the Terms of Use.
    time_unit: millisecond
    lifetime: application
    send_in_pings:
      - metrics
    notification_emails:
      - mviar@mozilla.com
      - omc-core@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971184
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974150
    expires: never

third.party.modules:
  blocked_modules:
    type: string_list
    description: |
      List of all DLL filenames that are on the dynamic blocklist.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_sensitivity:
      - technical
    notification_emails:
      - gstoll@mozilla.com
    expires: never
    send_in_pings:
      - third-party-modules

  modules:
    type: object
    description: |
      The third-party modules we saw get loaded into Firefox.
      Maximum of 100 modules.
      ```text
      [{
        resolvedDllName: sanitized string name of the module as resolved by the Windows loader,
        fileVersion: string version of the DLL as contained in its resources's fixed version information,
        companyName: string value of the CompanyName field as extracted from the DLL's version information. This property is only present when such version info is present, and when the 'signedBy' property is absent,
        signedBy: string name of the organization whose certificate was used to sign the DLL. Only present for signed modules,
        trustFlags: Flags that indicate this module's level of trustworthiness. This corresponds to one or more `mozilla::ModuleTrustFlags` OR'd together to form a number,
      }, ...]
      ```
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_sensitivity:
      - technical
    notification_emails:
      - gstoll@mozilla.com
    expires: never
    send_in_pings:
      - third-party-modules
    structure:
      type: array
      items:
        type: object
        properties:
          resolvedDllName:
            type: string
          fileVersion:
            type: string
          companyName:
            type: string
          signedBy:
            type: string
          trustFlags:
            type: number

  processes:
    type: object
    description: |
      The per-process third-party module load context and events.
      ```text
      [{
        processName: string containing processType and pid, formatted as `${processType}.0x${pid}`,
        processType: one of the process string names specified in `xpcom/build/GeckoProcessTypes.h` or "browser" for Default,
        elapsed: number of seconds since process creation that this object was generated,
        xulLoadDurationMS: number of milliseconds it took to load xul.dll,
        sanitizationFailures: number of dropped events due to failures in path sanitization,
        trustTestFailures: number of dropped events due to failures computing trust levels,
        events: [{ // Array of module load events for this process. The entries of this array are ordered to be in sync with the combinedStacks.stacks array (see below).
          processUptimeMS: number of milliseconds between process creation and when this event was generated,
          loadDurationMS: number of milliseconds of time spent loading this module,
          threadID: numeric id of the thread that loaded the module,
          threadName: string name of the thread that loaded the module, when applicable,
          requestedDllName: sanitized string name of the module that was requested by the invoking code. Only exists when it is different from resolvedDllName,
          baseAddress: string formatted as `0x%x`, the base address to which the loader mapped the module,
          moduleIndex: numeric index of the element in the `modules` array that contains details about the module that was loaded during this event,
          isDependent: boolean, true if the module is included in the executable's Import Directory Table,
          loadStatus: number, corresponding to a value of `ModuleLoadInfo::Status`, of the status of the DLL load,
        }, ...], // Max 50 events
        combinedStacks: {
          memoryMap: [[
            <string> name of the module symbol file (e.g. `xul.pdb`),
            <string> breakpad identifier for the module (e.g. `08A541B5942242BDB4AEABD8C87E4CFF2`),
          ], ...],
          stacks: [ // Array of stacks for this process. These entries are ordered to be in sync with the events array (above).
            [
              [
                <integer> module index, or -1 for failure/invalid,
                <integer> program counter relative to its module base, or an absolute PC if the module index is -1,
              ], ... // Up to 512 stack frames
            ], ... // Up to 50 stack traces
          ],
        ]
      }, ...] // Up to 100 processes' information
      ```
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1963853
    data_sensitivity:
      - technical
    notification_emails:
      - gstoll@mozilla.com
    expires: never
    send_in_pings:
      - third-party-modules
    structure:
      type: array
      items:
        type: object
        properties:
          processName:
            type: string
          processType:
            type: string
          elapsed:
            type: string # float
          xulLoadDurationMS:
            type: string # float
          sanitizationFailures:
            type: number
          trustTestFailures:
            type: number
          events:
            type: array
            items:
              type: object
              properties:
                processUptimeMS:
                  type: number
                loadDurationMS:
                  type: string # float
                threadID:
                  type: number
                threadName:
                  type: string
                requestedDllName:
                  type: string
                baseAddress:
                  type: string
                moduleIndex:
                  type: number
                isDependent:
                  type: boolean
                loadStatus:
                  type: number
          combinedStacks:
            type: object
            properties:
              memoryMap:
                type: array
                items:
                  type: array
                  items:
                    type: string
              stacks:
                type: array
                items:
                  type: array
                  items:
                    type: array
                    items:
                      type: number

startup.io:
  read:
    type: labeled_quantity
    unit: bytes
    description: |
      Windows-only.
      Cumulative bytes read by the application according to the OS, per startup
      phase.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    expires: never
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - perf-telemetry-alerts@mozilla.com
    labels:
      - sessionRestore
      - windowVisible

  write:
    type: labeled_quantity
    unit: bytes
    description: |
      Windows-only.
      Cumulative bytes written by the application according to the OS, per startup
      phase.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836
    expires: never
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - perf-telemetry-alerts@mozilla.com
    labels:
      - sessionRestore
      - windowVisible