mozilla-central/js/xpconnect/metrics.yaml

Source code

Revision control

Copy as Markdown

Other Tools

# 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!
---
$tags:
- 'Core :: XPConnect'
performance.clone.deserialize:
size:
description: >
Size of deserialized data, in bytes
type: memory_distribution
memory_unit: byte
bugs:
data_reviews:
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:
data_reviews:
notification_emails:
- sfink@mozilla.com
expires: never
time:
description: >
Time spent deserializing structured data
type: timing_distribution
time_unit: microsecond
bugs:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
nursery_bytes:
type: memory_distribution
memory_unit: byte
description: >
Size of the GC nursery in bytes.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
effectiveness:
type: custom_distribution
range_min: 0
range_max: 50000
bucket_count: 100
histogram_type: exponential
unit: "MB/s"
description: >
GC effectiveness, the amount of memory freed divided by main-thread collection time (MB/s)
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
zone_count:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 20
histogram_type: exponential
unit: "zones"
description: >
Total number of GC zones
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
zones_collected:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 20
histogram_type: exponential
unit: "zones"
description: >
Number of zones collected in a zone GC.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
pretenure_count:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 20
histogram_type: exponential
description: >
How many allocation sites were selected for pretenuring by a minor GC
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
mark_rate:
type: custom_distribution
range_min: 1000
range_max: 300000
bucket_count: 50
histogram_type: exponential
unit: "objects/ms"
description: >
The number of objects marked per ms during GC.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
slice_count:
type: custom_distribution
range_min: 0
range_max: 200
bucket_count: 50
histogram_type: exponential
unit: "objects/ms"
description: >
The number of slices in an incremental GC for the main runtime.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
parallel_mark_speedup:
type: custom_distribution
range_min: 50
range_max: 800
bucket_count: 50
histogram_type: exponential
description: >
Ratio of total helper thread time spent marking to main thread time for parallel marking, scaled by 100.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
parallel_mark_interruptions:
type: custom_distribution
range_min: 1
range_max: 500
bucket_count: 50
histogram_type: exponential
description: >
Number of interruptions/donations per slice during parallel marking.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
parallel_mark_utilization:
type: custom_distribution
range_min: 1
range_max: 100
bucket_count: 50
histogram_type: linear
unit: "percentage"
description: >
Ratio of helper thread time spent marking to total helper thread time for parallel marking.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
mmu_50:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 20
histogram_type: linear
unit: "percentage"
description: >
Minimum percentage of time spent outside GC over any 50ms window.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
nursery_promotion_rate:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 50
histogram_type: linear
unit: "percentage"
description: >
The percentage of nursery objects that were promoted to the tenured heap.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
tenured_survival_rate:
type: custom_distribution
range_min: 0
range_max: 100
bucket_count: 50
histogram_type: linear
unit: "percentage"
description: >
The percentage of tenured GC things that survived a collection.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
is_zone_gc:
type: labeled_counter
description: >
Is it a zone GC?
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
budget_was_increased:
type: labeled_counter
description: >
Whether the budget was increased due to taking too long or approaching the incremental limit
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
slice_was_long:
type: labeled_counter
description: >
Whether a GC slice took 1.5 times or 5ms more than its budget
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
reset:
type: labeled_counter
description: >
Was an incremental GC canceled?
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
non_incremental:
type: labeled_counter
description: >
Was the GC non-incremental?
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
parallel_mark_used:
type: labeled_counter
description: >
Whether parallel marking was used for this collection
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels:
- "false"
- "true"
reason:
type: labeled_counter
description: >
Reason (enum value) for initiating a GC
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: &gc_reasons
- API
- EAGER_ALLOC_TRIGGER
- DESTROY_RUNTIME
- ROOTS_REMOVED
- LAST_DITCH
- TOO_MUCH_MALLOC
- ALLOC_TRIGGER
- DEBUG_GC
- COMPARTMENT_REVIVED
- RESET
- OUT_OF_NURSERY
- EVICT_NURSERY
- SHARED_MEMORY_LIMIT
- EAGER_NURSERY_COLLECTION
- BG_TASK_FINISHED
- ABORT_GC
- FULL_WHOLE_CELL_BUFFER
- FULL_GENERIC_BUFFER
- FULL_VALUE_BUFFER
- FULL_CELL_PTR_OBJ_BUFFER
- FULL_SLOT_BUFFER
- FULL_SHAPE_BUFFER
- TOO_MUCH_WASM_MEMORY
- DISABLE_GENERATIONAL_GC
- FINISH_GC
- PREPARE_FOR_TRACING
- FULL_WASM_ANYREF_BUFFER
- FULL_CELL_PTR_STR_BUFFER
- TOO_MUCH_JIT_CODE
- FULL_CELL_PTR_BIGINT_BUFFER
- NURSERY_TRAILERS
- NURSERY_MALLOC_BUFFERS
- DOM_WINDOW_UTILS
- COMPONENT_UTILS
- MEM_PRESSURE
- CC_FINISHED
- CC_FORCED
- LOAD_END
- UNUSED3
- PAGE_HIDE
- NSJSCONTEXT_DESTROY
- WORKER_SHUTDOWN
- SET_DOC_SHELL
- DOM_UTILS
- DOM_IPC
- DOM_WORKER
- INTER_SLICE_GC
- UNUSED1
- FULL_GC_TIMER
- SHUTDOWN_CC
- UNUSED2
- USER_INACTIVE
- XPCONNECT_SHUTDOWN
- DOCSHELL
- HTML_PARSER
- DOM_TESTUTILS
- PREPARE_FOR_PAGELOAD
slow_phase:
type: labeled_counter
description: >
The longest phase in any slice that goes over 2x the budget. The phase values are defined in js/src/gc/GenerateStatsPhases.py.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: &gc_phases
- MUTATOR
- GC_BEGIN
- MARK_CCWS
- MARK_STACK
- MARK_RUNTIME_DATA
- MARK_EMBEDDING
- MARK_ROOTS
- EVICT_NURSERY_FOR_MAJOR_GC
- WAIT_BACKGROUND_THREAD
- UNMARK
- UNMARK_WEAKMAPS
- MARK_DISCARD_CODE
- RELAZIFY_FUNCTIONS
- PURGE
- PURGE_PROP_MAP_TABLES
- PURGE_SOURCE_URLS
- JOIN_PARALLEL_TASKS
- PREPARE
- MARK_DELAYED
- MARK_GRAY_WEAK
- MARK_WEAK
- MARK_INCOMING_GRAY
- MARK_GRAY
- PARALLEL_MARK_MARK
- PARALLEL_MARK_WAIT
- PARALLEL_MARK_OTHER
- PARALLEL_MARK
- MARK
- WEAK_ZONES_CALLBACK
- WEAK_COMPARTMENT_CALLBACK
- FINALIZE_START
- UPDATE_ATOMS_BITMAP
- SWEEP_ATOMS_TABLE
- SWEEP_DISCARD_CODE
- SWEEP_INNER_VIEWS
- SWEEP_CC_WRAPPER
- SWEEP_BASE_SHAPE
- SWEEP_INITIAL_SHAPE
- SWEEP_REGEXP
- SWEEP_COMPRESSION
- SWEEP_WEAKMAPS
- SWEEP_UNIQUEIDS
- SWEEP_WEAK_POINTERS
- SWEEP_FINALIZATION_OBSERVERS
- SWEEP_JIT_DATA
- SWEEP_WEAK_CACHES
- SWEEP_MISC
- SWEEP_COMPARTMENTS
- FINALIZE_OBJECT
- FINALIZE_NON_OBJECT
- SWEEP_PROP_MAP
- FINALIZE_END
- DESTROY
- FIND_DEAD_COMPARTMENTS
- SWEEP
- COMPACT_MOVE
- COMPACT_UPDATE_CELLS
- COMPACT_UPDATE
- COMPACT
- DECOMMIT
- GC_END
- MINOR_GC
- EVICT_NURSERY
- TRACE_HEAP
slow_task:
type: labeled_counter
description: >
The longest parallel task in any slice that goes over 2x the budget. The phase values are defined in js/src/gc/GenerateStatsPhases.py.
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: *gc_phases
reset_reason:
type: labeled_counter
description: >
Reason for cancelling an ongoing GC (see js::GCAbortReason)
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: &gc_abort_reasons
- None
- NonIncrementalRequested
- AbortRequested
- Unused1
- IncrementalDisabled
- ModeChange
- MallocBytesTrigger
- GCBytesTrigger
- ZoneChange
- CompartmentRevived
- GrayRootBufferingFailed
- JitCodeBytesTrigger
non_incremental_reason:
type: labeled_counter
description: >
Reason for performing a non-incremental GC (see js::GCAbortReason)
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: *gc_abort_reasons
minor_reason:
type: labeled_counter
description: >
Reason (enum value) for initiating a minor GC
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: *gc_reasons
minor_reason_long:
type: labeled_counter
description: >
Reason (enum value) that caused a long (>1ms) minor GC
bugs:
data_reviews:
notification_emails:
- dev-telemetry-gc-alerts@mozilla.org
- jcoppeard@mozilla.com
expires: never
labels: *gc_reasons
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
data_reviews: &slow_script_warning_shown_data_reviews
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
notify_delay:
type: timing_distribution
description: >
The difference between the js slow script timeout for content set in prefs
and the actual time we waited before displaying the notification (msec).
This metric was generated to correspond to the Legacy Telemetry
exponential histogram SLOW_SCRIPT_NOTIFY_DELAY.
time_unit: millisecond
bugs:
data_reviews:
notification_emails:
- perf-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: SLOW_SCRIPT_NOTIFY_DELAY
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:
data_reviews:
notification_emails:
- dothayer@mozilla.com
- plawless@mozilla.com
expires: never
telemetry_mirror: SCRIPT_PRELOADER_MAINTHREAD_RECOMPILE
requests:
type: labeled_counter
description: >
Record hits and misses to the script preloader, with categories.
This metric was generated to correspond to the Legacy Telemetry
categorical histogram SCRIPT_PRELOADER_REQUESTS.
labels:
- Hit
- HitChild
- Miss
bugs:
data_reviews:
notification_emails:
- dothayer@mozilla.com
- plawless@mozilla.com
expires: never
telemetry_mirror: h#SCRIPT_PRELOADER_REQUESTS
wait_time:
type: timing_distribution
description: >
Time spent waiting for off-thread compiles in the script preloader.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram SCRIPT_PRELOADER_WAIT_TIME.
time_unit: millisecond
bugs:
data_reviews:
notification_emails:
- dothayer@mozilla.com
- plawless@mozilla.com
expires: never
telemetry_mirror: SCRIPT_PRELOADER_WAIT_TIME
glam_experiment:
time:
type: timing_distribution
disabled: true
time_unit: microsecond
description: >
Duplicate of:
`performance.clone.deserialize.time`
Intended for the purpose of testing client side sampling of data. This
metric is disabled by default and will be enabled only for the purpose
of the experiment. See Bug 1947604 for more information.
bugs:
data_reviews:
notification_emails:
- tlong@mozilla.com
- efilho@mozilla.com
expires: 146