metrics.yaml (29229B)
1 # This Source Code Form is subject to the terms of the Mozilla Public 2 # License, v. 2.0. If a copy of the MPL was not distributed with this 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. 4 5 # Adding a new metric? We have docs for that! 6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html 7 8 --- 9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0 10 $tags: 11 - 'Firefox :: Profiles' 12 13 browser.backup: 14 enabled: 15 type: boolean 16 description: > 17 True if the BackupService has initialized and reached idle. You may want 18 to use archive_enabled/restore_enabled to determine whether those 19 features are available, or use scheduler_enabled for whether automatic 20 backups are enabled. 21 bugs: 22 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 23 data_reviews: 24 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 25 data_sensitivity: 26 - technical 27 notification_emails: 28 - mconley@mozilla.com 29 expires: never 30 telemetry_mirror: BROWSER_BACKUP_ENABLED 31 32 archive_enabled: 33 type: boolean 34 description: > 35 True if the user can create backups, i.e. it has not been disabled by a 36 pref or otherwise deemed incompatible. 37 bugs: 38 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997389 39 data_reviews: 40 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997389 41 data_sensitivity: 42 - technical 43 notification_emails: 44 - drubino@mozilla.com 45 expires: never 46 telemetry_mirror: BROWSER_BACKUP_ARCHIVE_ENABLED 47 48 restore_enabled: 49 type: boolean 50 description: > 51 True if the user can restore backups, i.e. it has not been disabled by a 52 pref or otherwise deemed incompatible. 53 bugs: 54 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997389 55 data_reviews: 56 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997389 57 data_sensitivity: 58 - technical 59 notification_emails: 60 - drubino@mozilla.com 61 expires: never 62 telemetry_mirror: BROWSER_BACKUP_RESTORE_ENABLED 63 64 scheduler_enabled: 65 type: boolean 66 description: > 67 True if the BackupService is configured to automatically create backups 68 in the background. 69 bugs: 70 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 71 data_reviews: 72 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 73 data_sensitivity: 74 - technical 75 notification_emails: 76 - mconley@mozilla.com 77 expires: never 78 telemetry_mirror: BROWSER_BACKUP_SCHEDULER_ENABLED 79 80 pswd_encrypted: 81 type: boolean 82 description: > 83 True if the BackupService is configured to encrypt backups. 84 bugs: 85 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 86 data_reviews: 87 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 88 data_sensitivity: 89 - technical 90 notification_emails: 91 - mconley@mozilla.com 92 expires: never 93 telemetry_mirror: BROWSER_BACKUP_PSWD_ENCRYPTED 94 95 location_on_device: 96 type: quantity 97 unit: enum (see description) 98 description: > 99 1 = the default location, 2 = a non-default location 100 bugs: 101 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 102 data_reviews: 103 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908727 104 data_sensitivity: 105 - technical 106 notification_emails: 107 - mconley@mozilla.com 108 expires: never 109 telemetry_mirror: BROWSER_BACKUP_LOCATION_ON_DEVICE 110 111 prof_d_disk_space: 112 type: quantity 113 unit: kilobyte 114 description: > 115 The total disk space available on the storage device that the profile 116 directory is stored on. To reduce fingerprintability, we round to the 117 nearest 10 megabytes and return the result in kilobytes. 118 bugs: 119 - https://bugzilla.mozilla.org/show_bug.cgi?id=1884407 120 data_reviews: 121 - https://bugzilla.mozilla.org/show_bug.cgi?id=1884407 122 data_sensitivity: 123 - technical 124 notification_emails: 125 - mconley@mozilla.com 126 expires: never 127 telemetry_mirror: BROWSER_BACKUP_PROF_D_DISK_SPACE 128 129 total_backup_size: 130 type: memory_distribution 131 memory_unit: megabyte 132 description: > 133 The total uncompressed size of all profile data included in a 134 completed backup. To reduce fingerprintability, we round to the 135 nearest 1 mebibyte. 136 bugs: 137 - https://bugzilla.mozilla.org/show_bug.cgi?id=1887765 138 data_reviews: 139 - https://bugzilla.mozilla.org/show_bug.cgi?id=1887765 140 data_sensitivity: 141 - technical 142 notification_emails: 143 - mconley@mozilla.com 144 expires: never 145 telemetry_mirror: BROWSER_BACKUP_TOTAL_BACKUP_SIZE 146 147 compressed_archive_size: 148 type: memory_distribution 149 memory_unit: megabyte 150 description: > 151 The total compressed size of a single-file profile data backup archive. 152 To reduce fingerprintability, we round to the nearest 1 mebibyte. 153 bugs: 154 - https://bugzilla.mozilla.org/show_bug.cgi?id=1907625 155 data_reviews: 156 - https://bugzilla.mozilla.org/show_bug.cgi?id=1907625 157 data_sensitivity: 158 - technical 159 notification_emails: 160 - mconley@mozilla.com 161 expires: never 162 telemetry_mirror: BROWSER_BACKUP_COMPRESSED_ARCHIVE_SIZE 163 164 total_backup_time: 165 type: timing_distribution 166 time_unit: millisecond 167 description: > 168 Total time elapsed, in milliseconds, between the start and end 169 of the profile backup creation process 170 bugs: 171 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 172 data_reviews: 173 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 174 data_sensitivity: 175 - technical 176 notification_emails: 177 - mconley@mozilla.com 178 expires: never 179 telemetry_mirror: BROWSER_BACKUP_TOTAL_BACKUP_TIME_MS 180 181 places_size: 182 type: quantity 183 unit: kilobyte 184 description: > 185 The total file size of the places.sqlite db located in the current profile 186 directory, in kilobytes. 187 bugs: 188 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883642 189 data_reviews: 190 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883642 191 data_sensitivity: 192 - technical 193 notification_emails: 194 - mconley@mozilla.com 195 expires: never 196 telemetry_mirror: BROWSER_BACKUP_PLACES_SIZE 197 198 places_time: 199 type: timing_distribution 200 time_unit: millisecond 201 description: > 202 Total time, in milliseconds, required to back up a profile's places 203 database. 204 bugs: 205 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 206 data_reviews: 207 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 208 data_sensitivity: 209 - technical 210 notification_emails: 211 - mconley@mozilla.com 212 expires: never 213 telemetry_mirror: BROWSER_BACKUP_PLACES_TIME_MS 214 215 favicons_size: 216 type: quantity 217 unit: kilobyte 218 description: > 219 The total file size of the favicons.sqlite db located in the current profile 220 directory, in kilobytes. 221 bugs: 222 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883642 223 data_reviews: 224 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883642 225 notification_emails: 226 - mconley@mozilla.com 227 expires: never 228 telemetry_mirror: BROWSER_BACKUP_FAVICONS_SIZE 229 230 favicons_time: 231 type: timing_distribution 232 time_unit: millisecond 233 description: > 234 Total time, in milliseconds, required to back up a profile's favicons 235 database. 236 bugs: 237 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 238 data_reviews: 239 - https://bugzilla.mozilla.org/show_bug.cgi?id=1891146 240 data_sensitivity: 241 - technical 242 notification_emails: 243 - mconley@mozilla.com 244 expires: never 245 telemetry_mirror: BROWSER_BACKUP_FAVICONS_TIME_MS 246 247 credentials_data_size: 248 type: quantity 249 unit: kilobyte 250 description: > 251 The total size of logins, payment method, and form autofill related files 252 in the current profile directory, in kilobytes. 253 bugs: 254 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883736 255 data_reviews: 256 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883736 257 data_sensitivity: 258 - technical 259 notification_emails: 260 - mconley@mozilla.com 261 expires: never 262 telemetry_mirror: BROWSER_BACKUP_CREDENTIALS_DATA_SIZE 263 264 security_data_size: 265 type: quantity 266 unit: kilobyte 267 description: > 268 The total size of files needed for NSS initialization parameters and security 269 certificate settings in the current profile directory, in kilobytes. 270 bugs: 271 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883736 272 data_reviews: 273 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883736 274 data_sensitivity: 275 - technical 276 notification_emails: 277 - mconley@mozilla.com 278 expires: never 279 telemetry_mirror: BROWSER_BACKUP_SECURITY_DATA_SIZE 280 281 preferences_size: 282 type: quantity 283 unit: kilobyte 284 description: > 285 The total size of files relating to user preferences and permissions in the current profile 286 directory, in kilobytes. 287 bugs: 288 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883739 289 data_reviews: 290 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883739 291 data_sensitivity: 292 - technical 293 notification_emails: 294 - mconley@mozilla.com 295 expires: never 296 telemetry_mirror: BROWSER_BACKUP_PREFERENCES_SIZE 297 298 misc_data_size: 299 type: quantity 300 unit: kilobyte 301 description: > 302 The total size of files for telemetry, site storage, media device origin mapping, 303 chrome privileged IndexedDB databases, and Mozilla Accounts in the current profile directory, 304 rounded to the nearest tenth kilobyte. 305 bugs: 306 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883747 307 - https://bugzilla.mozilla.org/show_bug.cgi?id=1887746 308 data_reviews: 309 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883747 310 - https://bugzilla.mozilla.org/show_bug.cgi?id=1887746 311 data_sensitivity: 312 - technical 313 notification_emails: 314 - mconley@mozilla.com 315 expires: never 316 telemetry_mirror: BROWSER_BACKUP_MISC_DATA_SIZE 317 318 cookies_size: 319 type: quantity 320 unit: kilobyte 321 description: > 322 The total file size of the cookies.sqlite db located in the current profile 323 directory, in kilobytes. 324 bugs: 325 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 326 data_reviews: 327 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 328 data_sensitivity: 329 - technical 330 notification_emails: 331 - mconley@mozilla.com 332 expires: never 333 telemetry_mirror: BROWSER_BACKUP_COOKIES_SIZE 334 335 form_history_size: 336 type: quantity 337 unit: kilobyte 338 description: > 339 The file size of the formhistory.sqlite db located in the current profile 340 directory, in kilobytes. 341 bugs: 342 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 343 data_reviews: 344 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 345 data_sensitivity: 346 - technical 347 notification_emails: 348 - mconley@mozilla.com 349 expires: never 350 telemetry_mirror: BROWSER_BACKUP_FORM_HISTORY_SIZE 351 352 session_store_backups_directory_size: 353 type: quantity 354 unit: kilobyte 355 description: > 356 The total size of the session store backups directory, in kilobytes. 357 bugs: 358 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 359 data_reviews: 360 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 361 data_sensitivity: 362 - technical 363 notification_emails: 364 - mconley@mozilla.com 365 expires: never 366 telemetry_mirror: BROWSER_BACKUP_SESSION_STORE_BACKUPS_DIRECTORY_SIZE 367 368 session_store_size: 369 type: quantity 370 unit: kilobyte 371 description: > 372 The size of uncompressed session store json, in kilobytes. 373 bugs: 374 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 375 data_reviews: 376 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883740 377 data_sensitivity: 378 - technical 379 notification_emails: 380 - mconley@mozilla.com 381 expires: never 382 telemetry_mirror: BROWSER_BACKUP_SESSION_STORE_SIZE 383 384 extensions_json_size: 385 type: quantity 386 unit: kilobyte 387 description: > 388 The total file size of the current profiles extensions metadata files, 389 rounded to the nearest 10 kilobytes. 390 Files included are: 391 - extensions.json 392 - extension-settings.json 393 - extension-preferences.json 394 - addonStartup.json.lz4 395 bugs: 396 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 397 data_reviews: 398 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 399 data_sensitivity: 400 - technical 401 notification_emails: 402 - mconley@mozilla.com 403 expires: never 404 telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_JSON_SIZE 405 406 extension_store_permissions_data_size: 407 type: quantity 408 unit: kilobyte 409 description: > 410 The file size of the current profiles extension-store-permissions/data.safe.bin 411 file, rounded to the nearest 10 kilobytes. 412 bugs: 413 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 414 data_reviews: 415 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 416 data_sensitivity: 417 - technical 418 notification_emails: 419 - mconley@mozilla.com 420 expires: never 421 telemetry_mirror: BROWSER_BACKUP_EXTENSION_STORE_PERMISSIONS_DATA_SIZE 422 423 storage_sync_size: 424 type: quantity 425 unit: kilobyte 426 description: > 427 The file size of the current profiles storage-sync-v2.sqlite db, 428 rounded to the nearest 10 kilobytes. 429 bugs: 430 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 431 data_reviews: 432 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 433 data_sensitivity: 434 - technical 435 notification_emails: 436 - mconley@mozilla.com 437 expires: never 438 telemetry_mirror: BROWSER_BACKUP_STORAGE_SYNC_SIZE 439 440 browser_extension_data_size: 441 type: quantity 442 unit: kilobyte 443 description: > 444 The total size of the current profiles storage.local legacy JSON backend 445 in the browser-extension-data directory, rounded to the nearest 10 kilobytes. 446 bugs: 447 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 448 data_reviews: 449 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 450 data_sensitivity: 451 - technical 452 notification_emails: 453 - mconley@mozilla.com 454 expires: never 455 telemetry_mirror: BROWSER_BACKUP_BROWSER_EXTENSION_DATA_SIZE 456 457 extensions_xpi_directory_size: 458 type: quantity 459 unit: kilobyte 460 description: > 461 The total size of the current profiles extensions directory, 462 rounded to the nearest 10 kilobytes. 463 bugs: 464 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 465 data_reviews: 466 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 467 data_sensitivity: 468 - technical 469 notification_emails: 470 - mconley@mozilla.com 471 expires: never 472 telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_XPI_DIRECTORY_SIZE 473 474 extensions_storage_size: 475 type: quantity 476 unit: kilobyte 477 description: > 478 The total size of all extensions storage directories, 479 rounded to the nearest 10 kilobytes. 480 bugs: 481 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 482 data_reviews: 483 - https://bugzilla.mozilla.org/show_bug.cgi?id=1883655 484 data_sensitivity: 485 - technical 486 notification_emails: 487 - mconley@mozilla.com 488 expires: never 489 telemetry_mirror: BROWSER_BACKUP_EXTENSIONS_STORAGE_SIZE 490 491 toggle_on: 492 type: event 493 description: > 494 Dispatched when scheduled backups are enabled. 495 bugs: 496 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 497 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 498 data_reviews: 499 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 500 - https://phabricator.services.mozilla.com/D268774 501 data_sensitivity: 502 - interaction 503 send_in_pings: 504 - events 505 notification_emails: 506 - mconley@mozilla.com 507 expires: never 508 telemetry_mirror: BrowserBackup_ToggleOn_Backupservice 509 extra_keys: 510 encrypted: 511 type: boolean 512 description: Whether or not encryption is enabled. 513 location: 514 type: string 515 description: > 516 The location of the backup. This can be either "onedrive", 517 "documents", or "other". "other" will be sent if the parent directory 518 of the backup doesn't match the default "documents" or "onedrive" 519 save paths. 520 521 toggle_off: 522 type: event 523 description: > 524 Dispatched when scheduled backups are disabled. 525 bugs: 526 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 527 data_reviews: 528 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 529 data_sensitivity: 530 - interaction 531 send_in_pings: 532 - events 533 notification_emails: 534 - mconley@mozilla.com 535 expires: never 536 telemetry_mirror: BrowserBackup_ToggleOff_Backupservice 537 538 created: 539 type: event 540 description: > 541 Dispatched when a backup is successfully created. 542 bugs: 543 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 544 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 545 data_reviews: 546 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 547 - https://phabricator.services.mozilla.com/D268774 548 data_sensitivity: 549 - technical 550 send_in_pings: 551 - events 552 notification_emails: 553 - mconley@mozilla.com 554 expires: never 555 telemetry_mirror: BrowserBackup_Created_Backupservice 556 extra_keys: 557 encrypted: 558 type: boolean 559 description: Whether or not encryption is enabled for the backup. 560 location: 561 type: string 562 description: > 563 The location of the backup. This can be either "onedrive", 564 "documents", or "other". "other" will be sent if the parent directory 565 of the backup doesn't match the default "documents" or "onedrive" 566 save paths. 567 size: 568 type: quantity 569 description: > 570 The size-on-disk of the created backup. This is rounded to the 571 nearest mebibyte to reduce fingerprintability. 572 573 change_location: 574 type: event 575 description: > 576 Dispatched when the backup destination location is changed. 577 bugs: 578 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 579 data_reviews: 580 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 581 data_sensitivity: 582 - interaction 583 send_in_pings: 584 - events 585 notification_emails: 586 - mconley@mozilla.com 587 expires: never 588 telemetry_mirror: BrowserBackup_ChangeLocation_Backupservice 589 590 password_changed: 591 type: event 592 description: > 593 Dispatched when the backup encryption password is changed. 594 bugs: 595 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 596 data_reviews: 597 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 598 data_sensitivity: 599 - interaction 600 send_in_pings: 601 - events 602 notification_emails: 603 - mconley@mozilla.com 604 expires: never 605 telemetry_mirror: BrowserBackup_PasswordChanged_Backupservice 606 607 password_added: 608 type: event 609 description: > 610 Dispatched when the backup encryption is enabled. 611 bugs: 612 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 613 data_reviews: 614 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 615 data_sensitivity: 616 - interaction 617 send_in_pings: 618 - events 619 notification_emails: 620 - mconley@mozilla.com 621 expires: never 622 telemetry_mirror: BrowserBackup_PasswordAdded_Backupservice 623 624 password_removed: 625 type: event 626 description: > 627 Dispatched when the backup encryption is removed. 628 bugs: 629 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 630 data_reviews: 631 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 632 data_sensitivity: 633 - interaction 634 send_in_pings: 635 - events 636 notification_emails: 637 - mconley@mozilla.com 638 expires: never 639 telemetry_mirror: BrowserBackup_PasswordRemoved_Backupservice 640 641 error: 642 type: event 643 description: > 644 Dispatched when a backup fails to be created. We encode the error code 645 as well as the stage the backup failed in in the extra data. 646 bugs: 647 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 648 data_reviews: 649 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908732 650 data_sensitivity: 651 - interaction 652 send_in_pings: 653 - events 654 notification_emails: 655 - mconley@mozilla.com 656 expires: never 657 extra_keys: 658 error_code: 659 type: string 660 description: The string representation of the error code. 661 backup_step: 662 type: string 663 description: > 664 The string representation of the step that backup creation was in 665 when the error occurred. 666 telemetry_mirror: BrowserBackup_Error_Backupservice 667 668 backup_start: 669 type: event 670 description: > 671 Dispatched when a backup is initiated. 672 bugs: 673 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 674 data_reviews: 675 - https://phabricator.services.mozilla.com/D268774 676 data_sensitivity: 677 - interaction 678 notification_emails: 679 - drubino@mozilla.com 680 expires: never 681 extra_keys: 682 reason: 683 type: string 684 description: > 685 The reason that the backup was started. Can be one of the following: 686 - "manual" if the user selected "Backup Now"; 687 - "idle" if the user was idle and sufficiently long passed since 688 the last backup; 689 - "missed" if the user was idle, sufficiently long has passed since 690 the last backup, and this backup was scheduled to happen before; 691 - "user deleted some data" if cookies or other user data was 692 deleted; 693 - "encryption" if the password was added, changed, or removed; 694 - "location" if the location changed (not implemented yet, see 695 bug 1996377); 696 - "first" if scheduled backups were just enabled (not implemented 697 yet, see bug 1900125); 698 - or "unknown" if the reason wasn't specified. 699 700 backup_throttled: 701 type: event 702 description: > 703 Dispatched when backups are throttled due to too many errors. 704 bugs: 705 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 706 data_reviews: 707 - https://phabricator.services.mozilla.com/D268774 708 data_sensitivity: 709 - technical 710 notification_emails: 711 - drubino@mozilla.com 712 expires: never 713 714 archive_disabled_reason: 715 type: string 716 description: > 717 Only set if `browser.backup.enabled` is `false`. Possible reasons are 718 "nimbus", "pref" (non-Nimbus), "policy", "sanitizeOnShutdown", 719 "selectable profiles", "os version". 720 bugs: 721 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 722 data_reviews: 723 - https://phabricator.services.mozilla.com/D268774 724 data_sensitivity: 725 - technical 726 notification_emails: 727 - drubino@mozilla.com 728 expires: never 729 730 restore_disabled_reason: 731 type: string 732 description: > 733 Only set if `browser.backup.enabled` is `false`. Possible reasons are 734 "nimbus", "pref" (non-Nimbus), "policy", "sanitizeOnShutdown", 735 "selectable profiles". 736 bugs: 737 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992808 738 data_reviews: 739 - https://phabricator.services.mozilla.com/D268774 740 data_sensitivity: 741 - technical 742 notification_emails: 743 - drubino@mozilla.com 744 expires: never 745 746 restore_file_chosen: 747 type: event 748 description: Dispatched when a file is chosen to be restored. 749 bugs: 750 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 751 data_reviews: 752 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 753 data_sensitivity: 754 - interaction 755 send_in_pings: 756 - profile-restore 757 notification_emails: 758 - drubino@mozilla.com 759 expires: never 760 extra_keys: 761 location: 762 type: string 763 description: > 764 The location of the restore file. This can be either "onedrive", 765 "documents", or "other". "other" will be sent if the file's parent 766 directory doesn't match the default "documents" or "onedrive" save 767 paths. 768 valid: 769 type: boolean 770 description: > 771 If `false`, the selected restore file was invalid and could not be 772 restored. In this case, keys besides this one and `location` will not 773 be specified. 774 backup_timestamp: 775 type: quantity 776 description: > 777 The number of milliseconds between the epoch and the creation of the 778 backup. 779 restore_id: 780 type: string 781 description: The identifier for the potential profile restore event. 782 encryption: 783 type: boolean 784 description: > 785 `true` if the restore file chosen is encrypted. 786 app_name: 787 type: string 788 description: The name of the application that created the backup file. 789 version: 790 type: string 791 description: The application version that created the backup file. 792 build_id: 793 type: string 794 description: The build ID of the application that created the backup. 795 os_name: 796 type: string 797 description: The OS in which the backup was created. 798 os_version: 799 type: string 800 description: The OS version in which the backup was created. 801 telemetry_enabled: 802 type: boolean 803 description: Whether telemetry was enabled when the backup was created. 804 805 restore_started: 806 type: event 807 description: Dispatched when a file is chosen to be restored. 808 bugs: 809 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 810 data_reviews: 811 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 812 data_sensitivity: 813 - interaction 814 send_in_pings: 815 - profile-restore 816 notification_emails: 817 - drubino@mozilla.com 818 expires: never 819 extra_keys: 820 restore_id: 821 type: string 822 description: The identifier for the potential profile restore event. 823 824 restore_failed: 825 type: event 826 description: Dispatched when a restore fails (prior to Firefox restart). 827 bugs: 828 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 829 data_reviews: 830 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 831 data_sensitivity: 832 - technical 833 send_in_pings: 834 - profile-restore 835 notification_emails: 836 - drubino@mozilla.com 837 expires: never 838 extra_keys: 839 restore_id: 840 type: string 841 description: The identifier for the potential profile restore event. 842 error_type: 843 type: string 844 description: > 845 The reason for the failure. Possible values include, but are not 846 limited to, "UNAUTHORIZED" (bad password provided by user), 847 "CORRUPTED_ARCHIVE", and "FILE_SYSTEM_ERROR". 848 849 restore_complete: 850 type: event 851 description: > 852 Dispatched when a restore completes, just before the browser restarts into 853 the restored profile. 854 bugs: 855 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 856 data_reviews: 857 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 858 data_sensitivity: 859 - interaction 860 send_in_pings: 861 - profile-restore 862 notification_emails: 863 - drubino@mozilla.com 864 expires: never 865 extra_keys: 866 restore_id: 867 type: string 868 description: The identifier for the potential profile restore event. 869 870 restored_profile_launched: 871 type: event 872 description: > 873 Dispatched when a restore completes, after the browser restarts into the 874 restored profile (from that profile). Note that this will not be sent if 875 the new profile has telemetry disabled. 876 bugs: 877 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 878 data_reviews: 879 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 880 data_sensitivity: 881 - interaction 882 send_in_pings: 883 - post-profile-restore 884 notification_emails: 885 - drubino@mozilla.com 886 expires: never 887 extra_keys: 888 restore_id: 889 type: string 890 description: The identifier for the potential profile restore event. 891 892 restored_profile_data: 893 type: object 894 description: > 895 Describes the backup that was restored to make the current profile. If 896 This is not a restored profile, `is_restored` will be set to `false` and 897 no other values will be set. 898 bugs: 899 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 900 data_reviews: 901 - https://bugzilla.mozilla.org/show_bug.cgi?id=1992809 902 data_sensitivity: 903 - technical 904 send_in_pings: 905 - post-profile-restore 906 notification_emails: 907 - drubino@mozilla.com 908 expires: never 909 structure: 910 type: object 911 properties: 912 is_restored: 913 type: boolean 914 backup_timestamp: 915 type: number 916 backup_app_name: 917 type: string 918 backup_app_version: 919 type: string 920 backup_build_id: 921 type: string 922 backup_os_name: 923 type: string 924 backup_os_version: 925 type: string 926 backup_legacy_client_id: 927 type: string