# 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 platform-specific code at build time using the
# `glean_parser` PyPI package.

# This file is presently for Internal FOG Use Only.
# You should not add metrics here until probably about January of 2021.
# If you're looking for the metrics.yaml for Geckoveiw Streaming Telemetry,
# you can find that one in toolkit/components/telemetry/geckoview/streaming.

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

fog:
  initialization:
    type: timespan
    time_unit: nanosecond
    description: |
      Time the FOG initialization takes.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1662123
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1662123#c3
    data_sensitivity:
      - technical
    notification_emails:
      - jrediger@mozilla.com
      - glean-team@mozilla.com
    expires: never

fog.ipc:
  replay_failures:
    type: counter
    description: |
      The number of times the ipc buffer failed to be replayed in the
      parent process.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1664461
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1664461
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

fog_validation:
  legacy_telemetry_client_id:
    type: uuid
    description:
      The Telemetry client_id.
      To be sent only in the "fog-validation" ping.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1674233
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1674233#c4
    data_sensitivity:
      - technical
      - highly_sensitive
    lifetime: application
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: "89"
    send_in_pings:
      - fog-validation

  os_version:
    type: string
    description:
      The version of the OS running Firefox, as detected by Gecko.
      To be sent only in the "fog-validation" ping.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1679835
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1679835#c3
    data_sensitivity:
      - technical
    lifetime: application
    notification_emails:
      - aplacitelli@mozilla.com
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: "89"
    send_in_pings:
      - fog-validation

  profile_disk_is_ssd:
    type: boolean
    description:
      True iff the type of the disk the current Firefox profile is stored on
      is an SSD. (Windows only).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675877
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675877#c7
    data_sensitivity:
      - technical
    lifetime: application
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: "89"
    send_in_pings:
      - fog-validation