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:
- 'Firefox :: Profiles'
browser.backup:
enabled:
type: boolean
description: >
True if the BackupService is enabled by default.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_ENABLED
scheduler_enabled:
type: boolean
description: >
True if the BackupService is configured to automatically create backups
in the background.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_SCHEDULER_ENABLED
pswd_encrypted:
type: boolean
description: >
True if the BackupService is configured to encrypt backups.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_PSWD_ENCRYPTED
location_on_device:
type: quantity
unit: enum (see description)
description: >
1 = the default location, 2 = a non-default location
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_LOCATION_ON_DEVICE
prof_d_disk_space:
type: quantity
unit: kilobyte
description: >
The total disk space available on the storage device that the profile
directory is stored on. To reduce fingerprintability, we round to the
nearest 10 megabytes and return the result in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_PROF_D_DISK_SPACE
total_backup_size:
type: memory_distribution
memory_unit: megabyte
description: >
The total uncompressed size of all profile data included in a
completed backup. To reduce fingerprintability, we round to the
nearest 1 mebibyte.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_TOTAL_BACKUP_SIZE
compressed_archive_size:
type: memory_distribution
memory_unit: megabyte
description: >
The total compressed size of a single-file profile data backup archive.
To reduce fingerprintability, we round to the nearest 1 mebibyte.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_COMPRESSED_ARCHIVE_SIZE
total_backup_time:
type: timing_distribution
time_unit: millisecond
description: >
Total time elapsed, in milliseconds, between the start and end
of the profile backup creation process
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_TOTAL_BACKUP_TIME_MS
places_size:
type: quantity
unit: kilobyte
description: >
The total file size of the places.sqlite db located in the current profile
directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_PLACES_SIZE
places_time:
type: timing_distribution
time_unit: millisecond
description: >
Total time, in milliseconds, required to back up a profile's places
database.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_PLACES_TIME_MS
favicons_size:
type: quantity
unit: kilobyte
description: >
The total file size of the favicons.sqlite db located in the current profile
directory, in kilobytes.
bugs:
data_reviews:
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_FAVICONS_SIZE
favicons_time:
type: timing_distribution
time_unit: millisecond
description: >
Total time, in milliseconds, required to back up a profile's favicons
database.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_FAVICONS_TIME_MS
credentials_data_size:
type: quantity
unit: kilobyte
description: >
The total size of logins, payment method, and form autofill related files
in the current profile directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_CREDENTIALS_DATA_SIZE
security_data_size:
type: quantity
unit: kilobyte
description: >
The total size of files needed for NSS initialization parameters and security
certificate settings in the current profile directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_SECURITY_DATA_SIZE
preferences_size:
type: quantity
unit: kilobyte
description: >
The total size of files relating to user preferences and permissions in the current profile
directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_PREFERENCES_SIZE
misc_data_size:
type: quantity
unit: kilobyte
description: >
The total size of files for telemetry, site storage, media device origin mapping,
chrome privileged IndexedDB databases, and Mozilla Accounts in the current profile directory,
rounded to the nearest tenth kilobyte.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_MISC_DATA_SIZE
cookies_size:
type: quantity
unit: kilobyte
description: >
The total file size of the cookies.sqlite db located in the current profile
directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_COOKIES_SIZE
form_history_size:
type: quantity
unit: kilobyte
description: >
The file size of the formhistory.sqlite db located in the current profile
directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_FORM_HISTORY_SIZE
session_store_backups_directory_size:
type: quantity
unit: kilobyte
description: >
The total size of the session store backups directory, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_SESSION_STORE_BACKUPS_DIRECTORY_SIZE
session_store_size:
type: quantity
unit: kilobyte
description: >
The size of uncompressed session store json, in kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_SESSION_STORE_SIZE
extensions_json_size:
type: quantity
unit: kilobyte
description: >
The total file size of the current profiles extensions metadata files,
rounded to the nearest 10 kilobytes.
Files included are:
- extensions.json
- extension-settings.json
- extension-preferences.json
- addonStartup.json.lz4
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_JSON_SIZE
extension_store_permissions_data_size:
type: quantity
unit: kilobyte
description: >
The file size of the current profiles extension-store-permissions/data.safe.bin
file, rounded to the nearest 10 kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_EXTENSION_STORE_PERMISSIONS_DATA_SIZE
storage_sync_size:
type: quantity
unit: kilobyte
description: >
The file size of the current profiles storage-sync-v2.sqlite db,
rounded to the nearest 10 kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_STORAGE_SYNC_SIZE
browser_extension_data_size:
type: quantity
unit: kilobyte
description: >
The total size of the current profiles storage.local legacy JSON backend
in the browser-extension-data directory, rounded to the nearest 10 kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_BROWSER_EXTENSION_DATA_SIZE
extensions_xpi_directory_size:
type: quantity
unit: kilobyte
description: >
The total size of the current profiles extensions directory,
rounded to the nearest 10 kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_XPI_DIRECTORY_SIZE
extensions_storage_size:
type: quantity
unit: kilobyte
description: >
The total size of all extensions storage directories,
rounded to the nearest 10 kilobytes.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_STORAGE_SIZE
toggle_on:
type: event
description: >
Dispatched when scheduled backups are enabled.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_ToggleOn_Backupservice
toggle_off:
type: event
description: >
Dispatched when scheduled backups are disabled.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_ToggleOff_Backupservice
created:
type: event
description: >
Dispatched when a backup is successfully created.
bugs:
data_reviews:
data_sensitivity:
- technical
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_Created_Backupservice
change_location:
type: event
description: >
Dispatched when the backup destination location is changed.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_ChangeLocation_Backupservice
password_changed:
type: event
description: >
Dispatched when the backup encryption password is changed.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_PasswordChanged_Backupservice
password_added:
type: event
description: >
Dispatched when the backup encryption is enabled.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_PasswordAdded_Backupservice
password_removed:
type: event
description: >
Dispatched when the backup encryption is removed.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: BrowserBackup_PasswordRemoved_Backupservice
error:
type: event
description: >
Dispatched when a backup fails to be created. We encode the error code
as well as the stage the backup failed in in the extra data.
bugs:
data_reviews:
data_sensitivity:
- interaction
send_in_pings:
- events
notification_emails:
- mconley@mozilla.com
expires: never
extra_keys:
error_code:
type: string
description: The string representation of the error code.
backup_step:
type: string
description: >
The string representation of the step that backup creation was in
when the error occurred.
telemetry_mirror: BrowserBackup_Error_Backupservice