# 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:
  - 'Core :: DOM: Navigation'

performance.page:
  total_content_page_load:
    type: timing_distribution
    time_unit: millisecond
    telemetry_mirror: TOTAL_CONTENT_PAGE_LOAD_TIME
    description: >
      Time to load all of a page's resources and render.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - bdekoz@mozilla.com
    expires: never

bfcache:
  combo:
    type: labeled_counter
    description: >
      The common combinations of BFCacheStatus when we determine whether the
      page can be BFCached or not; If it's BFCached, we record BFCache_Success;
      Success_Not_Toplevel represents the number of not the only top level
      document in BrowsingContextGroup's documents that are BFCached, and
      BFCache_Success includes Success_Not_Toplevel; If it's not and it falls
      under common failure reasons combinations, we record the corresponding
      combination; Otherwise, we record Other to indicate this is not a common
      failure

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram BFCACHE_COMBO.
    labels:
      - BFCache_Success
      - Success_Not_Toplevel
      - Unload
      - Unload_Req
      - Req
      - Unload_Req_Peer
      - Unload_Req_Peer_MSE
      - Unload_Req_MSE
      - SPD_Unload_Req_Peer
      - Remote_Subframes
      - Beforeunload
      - Other
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1531917
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1531917
    notification_emails:
      - sefeng@mozilla.com
    expires: never
    telemetry_mirror: h#BFCACHE_COMBO

  page_restored:
    type: labeled_counter
    description: >
      Whether bfcache is used when loading a page from session history

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