forked from mozilla/application-services
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metrics.yaml
1019 lines (1010 loc) · 31.4 KB
/
metrics.yaml
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
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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/.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
sync_v2:
sync_uuid:
type: uuid
description: >
Unique identifier for this sync, used to correlate together
individual pings for data types that were synchronized together
(history, bookmarks, logins).
If a data type is synchronized by itself via the legacy 'sync' API
(as opposed to the Sync Manager),
then this field will not be set on the corresponding ping.
send_in_pings:
- sync
- history-sync
- bookmarks-sync
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/5371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5386#pullrequestreview-392363687
data_sensitivity:
- technical
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records a global sync failure: either due to an authentication error,
unexpected exception, or other error that caused the sync to fail.
Error strings are truncated and sanitized to omit
PII, like URLs and file system paths.
send_in_pings:
- sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
# `history-sync`, `logins-sync`, `bookmarks-sync`, `creditcards-sync`,
# `addresses-sync` and `tabs-sync` metrics
# mostly use the same structure, with some minor variability,
# but must be specified individually. We can't define them once and use
# `send_in_pings` because the stores might be synced in parallel, and we can't
# guarantee that a ping for one store would be sent before the others.
history_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the history sync started.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the history sync finished. This includes the time to
download, apply, and upload all records.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming history record counts. `applied` is the number of
incoming history pages that were successfully stored or updated in the
local database. `failed_to_apply` is the number of pages that were
ignored due to errors. `reconciled` is the number of pages with new visits
locally and remotely, and had their visits merged.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing history record counts. `uploaded` is the number of
records that were successfully sent to the server. `failed_to_upload`
is the number of records that weren't uploaded, and will be retried
on the next sync.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records. The
Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and
large syncs may require multiple batches.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records why the history sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are
truncated and sanitized to omit PII, like URLs and file system paths.
send_in_pings:
- history-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
logins_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the passwords sync started.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the passwords sync finished. This includes the time to
download, apply, and upload all records.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming passwords record counts. `applied` is the number of
incoming passwords entries that were successfully stored or updated in the
local database. `failed_to_apply` is the number of entries that were
ignored due to errors. `reconciled` is the number of entries with changes
both locally and remotely that were merged.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing passwords record counts. `uploaded` is the number of
records that were successfully sent to the server. `failed_to_upload`
is the number of records that weren't uploaded, and will be retried
on the next sync.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records. The
Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and
large syncs may require multiple batches.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records why the passwords sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are
truncated and sanitized to omit PII, like usernames and passwords.
send_in_pings:
- logins-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/4556
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/5294
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
bookmarks_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the bookmark sync started.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the bookmark sync finished.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming bookmark record counts.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing bookmark record counts.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records bookmark sync failure reasons.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
remote_tree_problems:
type: labeled_counter
labels:
- orphans
- misparented_roots
- multiple_parents_by_children
- missing_parent_guids
- non_folder_parent_guids
- parent_child_disagreements
- missing_children
description: >
Records counts for structure problems and divergences in the remote
bookmarks tree. These are documented in
https://github.com/mozilla/dogear/blob/fbade15f2a4f11215e30b8f428a0a8df3defeaec/src/tree.rs#L1273-L1294.
send_in_pings:
- bookmarks-sync
bugs:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/3092
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
creditcards_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the credit cards sync started.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the credit cards sync finished. This includes the time to
download, apply, and upload all records.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming credit cards record counts. `applied` is the number of
incoming records that were successfully stored or updated in the
local database. `failed_to_apply` is the number of records that were
ignored due to errors. `reconciled` is the number of merged records.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing credit cards record counts. `uploaded` is the number of
records that were successfully sent to the server. `failed_to_upload`
is the number of records that weren't uploaded, and will be retried
on the next sync.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records. The
Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and
large syncs may require multiple batches.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records why the credit cards sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are
truncated and sanitized to omit PII, like URLs and file system paths.
send_in_pings:
- creditcards-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
addresses_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the addresses sync started.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the addresses sync finished. This includes the time to
download, apply, and upload all records.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming addresses record counts. `applied` is the number of
incoming records that were successfully stored or updated in the
local database. `failed_to_apply` is the number of records that were
ignored due to errors. `reconciled` is the number of merged records.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing addresses record counts. `uploaded` is the number of
records that were successfully sent to the server. `failed_to_upload`
is the number of records that weren't uploaded, and will be retried
on the next sync.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records. The
Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and
large syncs may require multiple batches.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records why the addresses sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are
truncated and sanitized to omit PII, like URLs and file system paths.
send_in_pings:
- addresses-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
tabs_sync_v2:
uid:
type: string
description: >
The user's hashed Firefox Account ID.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
started_at:
type: datetime
time_unit: millisecond
description: >
Records when the tabs sync started.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
finished_at:
type: datetime
time_unit: millisecond
description: >
Records when the tabs sync finished. This includes the time to
download, apply, and upload all records.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
incoming:
type: labeled_counter
labels:
- applied
- failed_to_apply
- reconciled
description: >
Records incoming tabs record counts. `applied` is the number of
incoming records that were successfully stored or updated in the
local database. `failed_to_apply` is the number of records that were
ignored due to errors. `reconciled` is the number of merged records.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing:
type: labeled_counter
labels:
- uploaded
- failed_to_upload
description: >
Records outgoing tabs record counts. `uploaded` is the number of
records that were successfully sent to the server. `failed_to_upload`
is the number of records that weren't uploaded, and will be retried
on the next sync.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
outgoing_batches:
type: counter
description: >
Records the number of batches needed to upload all outgoing records. The
Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and
large syncs may require multiple batches.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
failure_reason:
type: labeled_string
labels:
- other
- unexpected
- auth
description: >
Records why the tabs sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are
truncated and sanitized to omit PII, like URLs and file system paths.
send_in_pings:
- tabs-sync
bugs:
- https://github.com/mozilla-mobile/android-components/issues/10371
data_reviews:
- https://github.com/mozilla-mobile/android-components/pull/10372#issuecomment-850378481
data_sensitivity:
- interaction
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
lifetime: ping
fxa_tab_v2:
sent:
type: event
description: >
Recorded when a tab is sent. Also sent by desktop - see also the docs at
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/sync-ping.html
send_in_pings:
- sync
extra_keys:
flow_id:
type: string
description: >
A guid, unique for the URL being sent but common for all target
devices. The value is randomly generated so can not identify details
about the user or tab.
stream_id:
type: string
description: >
A guid, unique for both the URL being sent and the target device. The
value is randomly generated so can not identify details about the
user or tab.
bugs:
- https://github.com/mozilla/application-services/pull/3308
- https://github.com/mozilla-mobile/android-components/pull/7618
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1652902
notification_emails:
- sync-team@mozilla.com
- skhamis@mozilla.com
expires: never
received:
type: event
description: >
Recorded when a tab is received. Also sent by desktop - see also the
docs at
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/sync-ping.html
send_in_pings:
- sync
extra_keys:
flow_id:
type: string
description: >
A guid, unique for the URL being sent but common for all target