# 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 :: Startup and Profile System"

gecko:
  version:
    description: >
      The version of the Gecko engine, example: 74.0a1
      (Migrated from the geckoview metric of the same name).
    type: string
    # Temporary misuse of the user lifetime approved by Glean team
    # due to limitations in Geckoview streaming telemetry.
    # DO NOT DUPLICATE unless approved by Glean team.
    lifetime: user
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1611240
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1687219
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877576
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1611240#c2
    notification_emails:
      - gfx-telemetry-alerts@mozilla.com
    expires: never

  build_id:
    description: >
      The Buildid of the Gecko engine, example: 20200205124310
      (Migrated from the geckoview metric of the same name).
    type: string
    # Temporary misuse of the user lifetime approved by Glean team
    # due to limitations in Geckoview streaming telemetry.
    # DO NOT DUPLICATE unless approved by Glean team.
    lifetime: user
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1611240
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1687219
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877576
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1611240#c2
    notification_emails:
      - gfx-telemetry-alerts@mozilla.com
    expires: never

  safe_mode_usage:
    type: custom_distribution
    description: >
      Whether the user is in safe mode (No, Yes, Forced)

      This metric was generated to correspond to the Legacy Telemetry enumerated
      histogram SAFE_MODE_USAGE.
    range_min: 0
    range_max: 3
    bucket_count: 4
    histogram_type: linear
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956726
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956726
    notification_emails:
      - dtownsend@mozilla.com
    expires: never
    telemetry_mirror: SAFE_MODE_USAGE

os.environment:
  is_admin_without_uac:
    type: boolean
    description: >
      Indicates that the process is lauched with Admin privileges but
      without UAC.
      This metric was generated to correspond to the Legacy Telemetry
      scalar os.environment.is_admin_without_uac.
    bugs:
      - https://bugzil.la/1567219
    data_reviews:
      - https://bugzil.la/1567219
    notification_emails:
      - tkikuchi@mozilla.com
    expires: never
    telemetry_mirror: OS_ENVIRONMENT_IS_ADMIN_WITHOUT_UAC

launcher.process:
  state:
    type: quantity
    unit: LauncherRegistryInfo::EnabledState
    description: |
      Whether, and in what mode, the launcher process is enabled (or not).
      See `nsIXULRuntime.launcherProcessState`
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    notification_emails:
      - gstoll@mozilla.com
    data_sensitivity:
      - technical
    expires: never

e10s:
  enabled:
    type: boolean
    description: |
      Whether e10s is on, i.e. browser tabs open by default in a different
      process.
      See `nsIXULRuntime.browserTabsRemoteAutostart`
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    notification_emails:
      - nika@mozilla.com
    data_sensitivity:
      - technical
    expires: never

  multi_processes:
    type: quantity
    unit: max processes
    description: |
      Maximum number of processes that will be launched for regular web content.
      See `nsIXULRuntime.maxWebProcessCount`
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    notification_emails:
      - nika@mozilla.com
    data_sensitivity:
      - technical
    expires: never

fission:
  enabled:
    type: boolean
    description: |
      Whether fission is enabled this session, and subframes can load in a
      different process.
      See `nsIXULRuntime.fissionAutostart`
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
    notification_emails:
      - nika@mozilla.com
    data_sensitivity:
      - technical
    expires: never
