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
# Adding a new metric? We have docs for that!
---
$tags:
- 'WebExtensions :: General'
extensions:
use_remote_pref:
type: boolean
expires: never
lifetime: application
description: >
Corresponds to the value of `extensions.webextensions.remote` pref.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
use_remote_policy:
type: boolean
expires: never
lifetime: application
description: >
Corresponds to the value of `WebExtensionPolicy.useRemoteWebExtensions`.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
startup_cache_load_time:
type: timespan
time_unit: millisecond
expires: never
description: |
Time to load and deserialize the extensions startupCache data.
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
- lgreco@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: EXTENSIONS_STARTUPCACHE_LOAD_TIME
no_lint:
- GIFFT_NON_PING_LIFETIME
startup_cache_read_errors:
type: labeled_counter
expires: never
description: |
The number of times an unexpected error has been raised while reading
the extensions StartupCache file.
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: EXTENSIONS_STARTUPCACHE_READ_ERRORS
no_lint:
- GIFFT_NON_PING_LIFETIME
startup_cache_write_bytelength:
type: quantity
unit: bytes
expires: never
description: |
The amount of bytes written to the extensions StartupCache file.
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: EXTENSIONS_STARTUPCACHE_WRITE_BYTELENGTH
no_lint:
- GIFFT_NON_PING_LIFETIME
process_event:
type: labeled_counter
expires: never
description: |
Counters for how many times the extension process has crashed or been created.
The labels with "_fg" / "_bg" suffixes are only recorded in Android builds,
while the "created" and "crashed" labels are recorded on both Desktop and Android
builds.
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
labels:
- crashed_bg
- crashed_fg
- created_bg
- created_fg
- crashed_over_threshold_bg
- crashed_over_threshold_fg
extensions.apis.dnr:
startup_cache_read_size:
type: memory_distribution
memory_unit: byte
expires: 138
description: |
Amount of data read from the DNR startup cache file.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_STARTUPCACHE_READ_BYTES
startup_cache_read_time:
type: timing_distribution
time_unit: millisecond
expires: 138
description: |
Amount of time it takes to read data into the DNR startup cache file.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_STARTUPCACHE_READ_MS
startup_cache_write_size:
type: memory_distribution
memory_unit: byte
expires: 138
description: |
Amount of data written to the DNR startup cache file.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_STARTUPCACHE_WRITE_BYTES
startup_cache_write_time:
type: timing_distribution
time_unit: millisecond
expires: 138
description: |
Amount of time it takes to write data into the DNR startup cache file.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_STARTUPCACHE_WRITE_MS
startup_cache_entries:
type: labeled_counter
expires: 138
description: |
Counters for startup cache data hits or misses on initializating
DNR rules for extensions loaded on application startup.
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
labels:
- hit
- miss
telemetry_mirror: EXTENSIONS_APIS_DNR_STARTUP_CACHE_ENTRIES
no_lint:
- GIFFT_NON_PING_LIFETIME
validate_rules_time:
type: timing_distribution
time_unit: millisecond
expires: 138
description: |
Amount of time it takes to validate DNR rules of individual ruleset
when dynamic or static rulesets have been loaded from disk.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_VALIDATE_RULES_MS
evaluate_rules_time:
type: timing_distribution
time_unit: millisecond
expires: 138
description: |
Amount of time it takes to evaluate DNR rules for one network request.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: WEBEXT_DNR_EVALUATE_RULES_MS
evaluate_rules_count_max:
type: quantity
unit: rules
expires: 138
description: |
Max amount of DNR rules being evaluated.
lifetime: ping
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
telemetry_mirror: EXTENSIONS_APIS_DNR_EVALUATE_RULES_COUNT_MAX
extensions.data:
migrate_result:
type: event
description: |
These events are sent when an extension is migrating its data to the new
IndexedDB backend.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- addons-dev-internal@mozilla.com
extra_keys:
addon_id:
description: Id of the addon.
type: string
backend:
description: The selected backend ("JSONFile" / "IndexedDB").
type: string
data_migrated:
description: The old extension data has been migrated ("y" / "n").
type: string
error_name:
description: |
A DOMException error name if any ("OtherError" for unknown errors).
The error has been fatal if the `backend` extra key is "JSONFile",
otherwise it is a non fatal error which didn't prevented the
extension from switching to the IndexedDB backend.
type: string
has_jsonfile:
description: The extension has a JSONFile ("y" / "n").
type: string
has_olddata:
description: Extension had some data stored in JSONFile ("y" / "n").
type: string
expires: 140
storage_local_error:
type: event
description: |
These events are collected when an extension triggers an unexpected error
while running a storage.local API call (e.g. because of some underlying
QuotaManager and/or IndexedDB error).
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- addons-dev-internal@mozilla.com
extra_keys:
addon_id:
description: Id of the addon.
type: string
method:
description: The storage.local API method name.
type: string
error_name:
description: |
A DOMException error name if any ("OtherError" for unknown errors).
type: string
expires: 140
sync_usage_quotas:
type: event
description: |
These events record the basic stat about usage, and are collected the
first time an extension uses the sync storage API during a session.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- addons-dev-internal@mozilla.com
extra_keys:
addon_id:
description: Id of the addon.
type: string
total_size_bytes:
description: Size of the sync data.
type: quantity
items_count:
description: Number of items in sync storage.
type: quantity
items_over_quota:
description: Count of items larger than QUOTA_BYTES_PER_ITEM.
type: quantity
backend:
description: Backend engine used, currently either "kinto" or "rust"
type: string
expires: 140
extensions.counters:
browser_action_preload_result:
type: labeled_counter
expires: never
description: |
Number of times an event page hit the idle timeout and results in one of the labels.
# Keep these labels in sync with the ones in WEBEXT_BROWSERACTION_POPUP_PRELOAD_RESULT_COUNT
# as defined in Histograms.json
labels:
- popupShown
- clearAfterHover
- clearAfterMousedown
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
event_page_idle_result:
type: labeled_counter
expires: never
description: |
Number of times an event page hit the idle timeout and results in one of the labels.
# Keep these labels in sync with the ones in WEBEXT_EVENTPAGE_IDLE_RESULT_COUNT
# as defined in Histograms.json
labels:
- suspend
- reset_other
- reset_event
- reset_listeners
- reset_nativeapp
- reset_streamfilter
- reset_parentapicall
- permissions_request
- launchWebAuthFlow
lifetime: application
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
extensions.timing:
background_page_load:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes to load a WebExtensions background page, from when the
build function is called to when the page has finished processing the onload event.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
browser_action_popup_open:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes for a BrowserAction popup to open.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
content_script_injection:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes for content scripts from a WebExtension to be injected into a window.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
event_page_running_time:
type: custom_distribution
unit: ms
range_min: 1
range_max: 60000
bucket_count: 100
histogram_type: exponential
expires: never
description: |
Amount of time (keyed by addon id) that an event page has been running before being suspended,
or the entire addon shutdown.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
extension_startup:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes for a WebExtension to start up, from when the
startup function is called to when the startup promise resolves.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
page_action_popup_open:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes for a PageAction popup to open.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
storage_local_get_idb:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes to perform a get via storage.local using the IndexedDB backend.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical
storage_local_set_idb:
type: timing_distribution
time_unit: millisecond
expires: never
description: |
Amount of time it takes to perform a set via storage.local using the Indexed backend.
notification_emails:
- addons-dev-internal@mozilla.com
bugs:
data_reviews:
data_sensitivity:
- technical