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