glean/glean-core/metrics.yaml

# 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 defines the metrics that are recorded by the Glean SDK. They are
# automatically converted to Kotlin code at build time using the `glean_parser`
# PyPI package.

---
$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0

glean.baseline:
  duration:
    type: timespan
    description: |
      The duration of the last foreground session.      
    time_unit: second
    send_in_pings:
      - baseline
    bugs:
      - https://bugzilla.mozilla.org/1497894
      - https://bugzilla.mozilla.org/1519120
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never
  locale:
    type: string
    lifetime: application
    send_in_pings:
      - baseline
    description: |
      The locale of the application during initialization (e.g. "es-ES").
      If the locale can't be determined on the system, the value is
      ["und"](https://unicode.org/reports/tr35/#Unknown_or_Invalid_Identifiers),
      to indicate "undetermined".      
    bugs:
      - https://bugzilla.mozilla.org/1512938
      - https://bugzilla.mozilla.org/1525540
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

glean.internal.metrics:
  os:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    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
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  os_version:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The user-visible version of the operating system (e.g. "1.2.3").      
    bugs:
      - https://bugzilla.mozilla.org/1497894
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  device_manufacturer:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The manufacturer of the device the application is running on.
      Not set if the device manufacturer can't be determined (e.g. on Desktop).      
    bugs:
      - https://bugzilla.mozilla.org/1522552
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  device_model:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: >
      The model of the device the application is running on.
      On Android, this is Build.MODEL, the user-visible marketing name,
      like "Pixel 2 XL".
      Not set if the device model can't be determined (e.g. on Desktop).      
    bugs:
      - https://bugzilla.mozilla.org/1522552
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  architecture:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The architecture of the device, (e.g. "arm", "x86").      
    bugs:
      - https://bugzilla.mozilla.org/1497894
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  client_id:
    type: uuid
    description:
      A UUID uniquely identifying the client.
    send_in_pings:
      - glean_client_info
    lifetime: user
    bugs:
      - https://bugzilla.mozilla.org/1497894
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  app_build:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The build identifier generated by the CI system (e.g. "1234/A").      
    bugs:
      - https://bugzilla.mozilla.org/1508305
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  app_display_version:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The user visible version string (e.g. "1.0.3").      
    bugs:
      - https://bugzilla.mozilla.org/1508305
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1508305#c9
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  app_channel:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The channel the application is being distributed on.      
    bugs:
      - https://bugzilla.mozilla.org/1520741
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1520741#c18
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  first_run_date:
    type: datetime
    lifetime: user
    send_in_pings:
      - glean_client_info
    time_unit: day
    description: |
      The date of the first run of the application.      
    bugs:
      - https://bugzilla.mozilla.org/1525045
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1525045#c18
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  locale:
    type: string
    lifetime: application
    send_in_pings:
      - glean_client_info
    description: |
      The locale of the application during initialization (e.g. "es-ES").
      If the locale can't be determined on the system, the value is
      ["und"](https://unicode.org/reports/tr35/#Unknown_or_Invalid_Identifiers),
      to indicate "undetermined".      
    bugs:
      - https://bugzilla.mozilla.org/1601489
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1601489#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never

  ping_reason:
    type: string
    description: |
      The optional reason the ping was submitted.
      The specific values for reason are specific to each ping, and are
      documented in the ping's pings.yaml file.      
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1557048
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1609218#c4
    notification_emails:
      - glean-team@mozilla.com
    expires: never

glean.error:
  invalid_value:
    type: labeled_counter
    description:
      Counts the number of times a metric was set to an invalid value.
      The labels are the `category.name` identifier of the metric.
    bugs:
      - https://bugzilla.mozilla.org/1499761
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    send_in_pings:
      - all-pings
    no_lint:
      - COMMON_PREFIX

  invalid_label:
    type: labeled_counter
    description:
      Counts the number of times a metric was set with an invalid label.
      The labels are the `category.name` identifier of the metric.
    bugs:
      - https://bugzilla.mozilla.org/1499761
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    send_in_pings:
      - all-pings
    no_lint:
      - COMMON_PREFIX

  invalid_state:
    type: labeled_counter
    description:
      Counts the number of times a timing metric was used incorrectly.
      The labels are the `category.name` identifier of the metric.
    bugs:
      - https://bugzilla.mozilla.org/1566380
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    send_in_pings:
      - all-pings
    no_lint:
      - COMMON_PREFIX

  invalid_overflow:
    type: labeled_counter
    description:
      Counts the number of times a metric was set a value that overflew.
      The labels are the `category.name` identifier of the metric.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1591912
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1591912#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    send_in_pings:
      - all-pings
    no_lint:
      - COMMON_PREFIX

  preinit_tasks_overflow:
    type: counter
    description:
      The number of tasks queued in the pre-initialization buffer.
      Only sent if the buffer overflows.
    unit:
      tasks
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1609482
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1609482#c3
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    no_lint:
      - COMMON_PREFIX

glean.upload:
  ping_upload_failure:
    type: labeled_counter
    description:
      Counts the number of ping upload failures, by type of failure.
      This includes failures for all ping types,
      though the counts appear in the next successfully sent `metrics` ping.
    labels:
      - "status_code_4xx"
      - "status_code_5xx"
      - "status_code_unknown"
      - "unrecoverable"
      - "recoverable"
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1589124
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1589124#c1
    notification_emails:
      - glean-team@mozilla.com
    expires: never
    no_lint:
      - COMMON_PREFIX