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

# 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 :: XPConnect'


performance.clone.deserialize:
  size:
    description: >
      Size of deserialized data, in bytes
    type: memory_distribution
    memory_unit: byte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631#c4
    notification_emails:
      - sfink@mozilla.com
    expires: never

  items:
    description: >
      Size of deserialized data, in items
    type: custom_distribution
    unit: Serialized items
    histogram_type: exponential
    range_max: 2147483646
    bucket_count: 50
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631#c4
    notification_emails:
      - sfink@mozilla.com
    expires: never

  time:
    description: >
      Time spent deserializing structured data
    type: timing_distribution
    time_unit: microsecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717631#c4
    notification_emails:
      - sfink@mozilla.com
    expires: never

javascript.ion:
  compile_time:
    type: timing_distribution
    time_unit: microsecond
    description: >
      Time in microseconds of an Ion compilation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1918166
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1918166
    notification_emails:
      - dpalmeiro@mozilla.com
      - perf-telemetry-alerts@mozilla.com
    expires: never

javascript.gc:
  total_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The total time taken by a major collection.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c8
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  minor_time:
    type: timing_distribution
    time_unit: microsecond
    description: >
      The time taked by a minor (nursery) collection.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  prepare_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time spent in the preparation phase.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  mark_roots_time:
    type: timing_distribution
    time_unit: microsecond
    description: >
      The time spent marking GC roots.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  mark_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time spent in the mark phase.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  sweep_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time spent in the sweep phase.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  compact_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time spent in the compact phase.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  slice_time:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time spent running a GC slice.
      (Migrated from the geckoview metric of the same name.)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1877843
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1636419#c17
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  budget:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Requested GC slice budget.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  budget_overrun:
    type: timing_distribution
    time_unit: microsecond
    description: >
      How long a GC slice ran over its budget.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  animation:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Time spent running JS GC when animating.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  max_pause:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Longest GC slice in a GC.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  mark_gray:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Time spent marking gray GC objects.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  mark_weak:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Time spent marking GC objects held live through weakmaps.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  time_between:
    type: timing_distribution
    time_unit: second
    description: >
      Time spent in between garbage collections for the main runtime.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  time_between_slices:
    type: timing_distribution
    time_unit: millisecond
    description: >
      Time spent in between garbage collections for the main runtime.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

  task_start_delay:
    type: timing_distribution
    time_unit: microsecond
    description: >
      Delay between queuing a GC task and the task starting.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932957
    notification_emails:
      - dev-telemetry-gc-alerts@mozilla.org
      - jcoppeard@mozilla.com
    expires: never

slow_script_warning:
  shown_browser:
    type: event
    description: >
      Recorded when a slow script hang is resolved.
      This event was generated to correspond to the Legacy Telemetry event
      slow_script_warning.shown#browser.
    bugs: &slow_script_warning_shown_bugs
      - https://bugzil.la/1652613
      - https://bugzil.la/1667245
      - https://bugzil.la/1672572
    data_reviews: &slow_script_warning_shown_data_reviews
      - https://bugzil.la/1652613
      - https://bugzil.la/1667245
      - https://bugzil.la/1672572
    notification_emails: &slow_script_warning_shown_emails
      - dothayer@mozilla.com
      - esmyth@mozilla.com
      - gkruitbosch@mozilla.com
      - perf-telemetry-alerts@mozilla.com
    expires: never
    extra_keys:
      hang_duration:
        description: >
          How long we believe the hang continued (ms).
        type: string
      uri_type:
        description: >
          The kind of script URL that hung.
        type: string
    telemetry_mirror: Slow_script_warning_Shown_Browser

  shown_content:
    type: event
    description: >
      Recorded when a slow script hang is resolved.
      This event was generated to correspond to the Legacy Telemetry event
      slow_script_warning.shown#content.
    bugs: *slow_script_warning_shown_bugs
    data_reviews: *slow_script_warning_shown_data_reviews
    notification_emails: *slow_script_warning_shown_emails
    expires: never
    extra_keys:
      end_reason:
        description: >
          Why the warning was hidden (user action, the process becoming responsive again, the browser quitting, etc.)
        type: string
      wait_count:
        description: >
          How many times the user elected to wait.
        type: quantity
      hang_duration:
        description: >
          How long we believe the hang continued (ms).
        type: string
      n_tab_deselect:
        description: >
          How many times the user switched away from a tab affected by this hang.
        type: quantity
      uri_type:
        description: >
          The kind of script URL that hung.
        type: string
      uptime:
        description: >
          How long the notification was up (ms).
        type: string
    telemetry_mirror: Slow_script_warning_Shown_Content
    no_lint:
      - COMMON_PREFIX

script.preloader:
  mainthread_recompile:
    type: counter
    description: >
      How many times we ended up recompiling a script from the script
      preloader on the main thread.
      This metric was generated to correspond to the Legacy Telemetry
      scalar script.preloader.mainthread_recompile.
    bugs:
      - https://bugzil.la/1364235
      - https://bugzil.la/1590385
      - https://bugzil.la/1623098
      - https://bugzil.la/1649954
      - https://bugzil.la/1689257
      - https://bugzil.la/1754639
    data_reviews:
      - https://bugzil.la/1364235
      - https://bugzil.la/1590385
      - https://bugzil.la/1623098
      - https://bugzil.la/1649954
      - https://bugzil.la/1689257
      - https://bugzil.la/1754639
    notification_emails:
      - dothayer@mozilla.com
      - plawless@mozilla.com
    expires: never
    telemetry_mirror: SCRIPT_PRELOADER_MAINTHREAD_RECOMPILE