forked from mozilla/glean
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmetrics.yaml
838 lines (785 loc) · 23.8 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
# 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/.
# This file defines the metrics that are recorded by the Glean SDK.
# APIs to use these pings are automatically generated at build time using
# the `glean_parser` PyPI package.
# Metrics in this file may make use of SDK reserved ping names. See
# https://mozilla.github.io/glean/book/dev/core/internal/reserved-ping-names.html
# for additional information.
# Disable line-length rule because of links in descriptions.
# yamllint disable rule:line-length
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
glean.baseline:
duration:
type: timespan
description: |
The duration of the last foreground session.
time_unit: second
send_in_pings:
- baseline
bugs:
- https://bugzilla.mozilla.org/1497894
- https://bugzilla.mozilla.org/1519120
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
- interaction
notification_emails:
expires: never
glean.internal.metrics:
os:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The name of the operating system.
Possible values:
Android, iOS, Linux, Darwin, Windows,
FreeBSD, NetBSD, OpenBSD, Solaris, Unknown
bugs:
- https://bugzilla.mozilla.org/1497894
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
os_version:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The user-visible version of the operating system (e.g. "1.2.3").
If the version detection fails, this metric gets set to `Unknown`.
bugs:
- https://bugzilla.mozilla.org/1497894
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
windows_build_number:
type: quantity
lifetime: application
send_in_pings:
- glean_client_info
description: |
The optional Windows build number, reported by Windows
(e.g. 22000) and not set for other platforms.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1802094
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1802094
data_sensitivity:
- technical
notification_emails:
expires: never
unit: build_number
device_manufacturer:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The manufacturer of the device the application is running on.
Not set if the device manufacturer can't be determined (e.g. on Desktop).
bugs:
- https://bugzilla.mozilla.org/1522552
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
device_model:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The model of the device the application is running on.
On Android, this is Build.MODEL, the user-visible marketing name,
like "Pixel 2 XL".
Not set if the device model can't be determined (e.g. on Desktop).
bugs:
- https://bugzilla.mozilla.org/1522552
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
architecture:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The architecture of the device, (e.g. "arm", "x86").
bugs:
- https://bugzilla.mozilla.org/1497894
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
client_id:
type: uuid
description:
A UUID uniquely identifying the client.
send_in_pings:
- glean_client_info
lifetime: user
bugs:
- https://bugzilla.mozilla.org/1497894
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
app_build:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The build identifier generated by the CI system (e.g. "1234/A").
If the value was not provided through configuration,
this metric gets set to `Unknown`.
bugs:
- https://bugzilla.mozilla.org/1508305
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
app_display_version:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The user visible version string (e.g. "1.0.3").
If the value was not provided through configuration,
this metric gets set to `Unknown`.
bugs:
- https://bugzilla.mozilla.org/1508305
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1508305#c9
data_sensitivity:
- technical
notification_emails:
expires: never
app_channel:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The channel the application is being distributed on.
bugs:
- https://bugzilla.mozilla.org/1520741
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1520741#c18
data_sensitivity:
- technical
notification_emails:
expires: never
build_date:
type: datetime
time_unit: second
lifetime: application
send_in_pings:
- glean_client_info
description: |
The date & time the application was built.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1742448
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1742448#c17
data_sensitivity:
- technical
notification_emails:
expires: never
first_run_date:
type: datetime
lifetime: user
send_in_pings:
- glean_client_info
time_unit: day
description: |
The date of the first run of the application.
bugs:
- https://bugzilla.mozilla.org/1525045
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1525045#c18
data_sensitivity:
- technical
notification_emails:
expires: never
locale:
type: string
lifetime: application
send_in_pings:
- glean_client_info
description: |
The locale of the application during initialization (e.g. "es-ES").
If the locale can't be determined on the system, the value is
["und"](https://unicode.org/reports/tr35/#Unknown_or_Invalid_Identifiers),
to indicate "undetermined".
bugs:
- https://bugzilla.mozilla.org/1601489
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1601489#c3
data_sensitivity:
- technical
- interaction
notification_emails:
expires: never
telemetry_sdk_build:
type: string
lifetime: ping
send_in_pings:
- glean_internal_info
description: |
The version of the Glean SDK
at the time the ping was collected (e.g. 25.0.0).
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1556966
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
seq:
type: counter
lifetime: user
send_in_pings:
- glean_internal_info
description: |
A running counter of the number of times pings of this type have been
sent.
This metric definition is only used for documentation purposes:
internally, Glean instantiates the metric manually and calls it
`sequence`.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1556964
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
experiments:
type: string # It's not, but we don't have a way to specify its type
lifetime: application
send_in_pings:
- glean_internal_info
description: |
Optional. A dictionary of active experiments.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1552471
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
start_time:
type: datetime
time_unit: millisecond
lifetime: user
send_in_pings:
- glean_internal_info
description: |
The time of the start of collection of the data in the ping,
in local time and with minute precision, including timezone information.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1556966
- https://bugzilla.mozilla.org/show_bug.cgi?id=1827852
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
end_time:
type: datetime
time_unit: millisecond
lifetime: ping
send_in_pings:
- glean_internal_info
description: |
The time of the end of collection of the data in the ping,
in local time and with minute precision, including timezone information.
This is also the time this ping was generated
and is likely well before ping transmission time.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1556966
- https://bugzilla.mozilla.org/show_bug.cgi?id=1827852
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3
data_sensitivity:
- technical
notification_emails:
expires: never
reason:
type: string
lifetime: ping
send_in_pings:
- glean_internal_info
description: |
The optional reason the ping was submitted.
The specific values for reason are specific to each ping, and are
documented in the ping's pings.yaml file.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1557048
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1609218#c4
data_sensitivity:
- technical
notification_emails:
expires: never
glean.client.annotation:
experimentation_id:
type: string
lifetime: application
send_in_pings:
- all-pings
description: |
An experimentation identifier derived and provided by the application
for the purpose of experimentation enrollment.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848201
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1848201#c5
data_sensitivity:
- technical
notification_emails:
expires: never
glean.error:
invalid_value:
type: labeled_counter
description: |
Counts the number of times a metric was set to an invalid value.
The labels are the `category.name` identifier of the metric.
bugs:
- https://bugzilla.mozilla.org/1499761
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
data_sensitivity:
- technical
notification_emails:
expires: never
send_in_pings:
- all-pings
no_lint:
- COMMON_PREFIX
invalid_label:
type: labeled_counter
description: |
Counts the number of times a metric was set with an invalid label.
The labels are the `category.name` identifier of the metric.
bugs:
- https://bugzilla.mozilla.org/1499761
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
data_sensitivity:
- technical
notification_emails:
expires: never
send_in_pings:
- all-pings
no_lint:
- COMMON_PREFIX
invalid_state:
type: labeled_counter
description: |
Counts the number of times a timing metric was used incorrectly.
The labels are the `category.name` identifier of the metric.
bugs:
- https://bugzilla.mozilla.org/1566380
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1499761#c5
data_sensitivity:
- technical
notification_emails:
expires: never
send_in_pings:
- all-pings
no_lint:
- COMMON_PREFIX
invalid_overflow:
type: labeled_counter
description: |
Counts the number of times a metric was set a value that overflowed.
The labels are the `category.name` identifier of the metric.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1591912
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1591912#c3
data_sensitivity:
- technical
notification_emails:
expires: never
send_in_pings:
- all-pings
no_lint:
- COMMON_PREFIX
preinit_tasks_overflow:
version: 1
type: counter
description: |
The number of tasks that overflowed the pre-initialization buffer.
Only sent if the buffer ever overflows.
In Version 0 this reported the total number of tasks enqueued.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1609482
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1609482#c3
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
io:
type: counter
description: |
The number of times we encountered an IO error
when writing a pending ping to disk.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1686233
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1686233#c2
data_sensitivity:
- technical
notification_emails:
expires: never
glean.upload:
ping_upload_failure:
type: labeled_counter
description: |
Counts the number of ping upload failures, by type of failure.
This includes failures for all ping types,
though the counts appear in the next successfully sent `metrics` ping.
labels:
- "status_code_4xx"
- "status_code_5xx"
- "status_code_unknown"
- "unrecoverable"
- "recoverable"
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1589124
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1589124#c1
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
discarded_exceeding_pings_size:
type: memory_distribution
description: |
The size of pings that exceeded the maximum ping size allowed for upload.
memory_unit: kilobyte
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1597761
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1597761#c10
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
pending_pings_directory_size:
type: memory_distribution
description: |
The size of the pending pings directory upon initialization of Glean.
This does not include the size of the deletion request pings directory.
memory_unit: kilobyte
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1601550
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1601550#c3
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
deleted_pings_after_quota_hit:
type: counter
description: |
The number of pings deleted after the quota
for the size of the pending pings directory or number of files is hit.
Since quota is only calculated for the pending pings directory,
and deletion request ping live in a different directory,
deletion request pings are never deleted.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1601550
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1601550#c3
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
pending_pings:
type: counter
description: |
The total number of pending pings at startup.
This does not include deletion-request pings.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1665041
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1665041#c23
data_sensitivity:
- technical
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
send_success:
type: timing_distribution
time_unit: millisecond
description: |
Time needed for a successful send of a ping to the servers and getting a reply back
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592#c3
data_sensitivity:
- technical
notification_emails:
expires: never
send_failure:
type: timing_distribution
time_unit: millisecond
description: |
Time needed for a failed send of a ping to the servers and getting a reply back.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592#c3
data_sensitivity:
- technical
notification_emails:
expires: never
in_flight_pings_dropped:
type: counter
description: |
How many pings were dropped because we found them already in-flight.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1816401
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1816401
data_sensitivity:
- technical
notification_emails:
expires: never
missing_send_ids:
type: counter
description: |
How many ping upload responses did we not record as a success or failure
(in `glean.upload.send_success` or `glean.upload.send_failue`,
respectively) due to an inconsistency in our internal bookkeeping?
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1816400
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1816400
data_sensitivity:
- technical
notification_emails:
expires: never
glean.database:
size:
type: memory_distribution
description: |
The size of the database file at startup.
memory_unit: byte
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1656589
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1656589#c7
data_sensitivity:
- technical
notification_emails:
expires: never
rkv_load_error:
type: string
description: |
If there was an error loading the RKV database, record it.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1815253
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1815253
data_sensitivity:
- technical
notification_emails:
expires: never
write_time:
type: timing_distribution
time_unit: microsecond
description: |
The time it takes for a write-commit for the Glean database.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1896193
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1896193#c4
data_sensitivity:
- technical
notification_emails:
expires: never
disabled: true
glean.validation:
foreground_count:
type: counter
description: |
On mobile, the number of times the application went to foreground.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1683707
- https://bugzilla.mozilla.org/show_bug.cgi?id=1685712
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1683707#c2
data_sensitivity:
- technical
notification_emails:
expires:
never
pings_submitted:
type: labeled_counter
description: |
A count of the built-in pings submitted, by ping type.
This metric appears in both the metrics and baseline pings.
- On the metrics ping, the counts include the number of pings sent since
the last metrics ping (including the last metrics ping)
- On the baseline ping, the counts include the number of pings send since
the last baseline ping (including the last baseline ping)
Note: Previously this also recorded the number of submitted custom pings.
Now it only records counts for the Glean built-in pings.
send_in_pings:
- metrics
- baseline
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1586764
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1586764#c3
data_sensitivity:
- technical
notification_emails:
expires:
never
shutdown_wait:
type: timing_distribution
time_unit: millisecond
description: |
Time waited for the uploader at shutdown.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1814592#c3
data_sensitivity:
- technical
notification_emails:
expires: never
shutdown_dispatcher_wait:
type: timing_distribution
time_unit: millisecond
description: |
Time waited for the dispatcher to unblock during shutdown.
Most samples are expected to be below the 10s timeout used.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1828066
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1828066#c7
data_sensitivity:
- technical
notification_emails:
expires: never
glean:
restarted:
type: event
description: |
Recorded when the Glean SDK is restarted.
Only included in custom pings that record events.
For more information, please consult the
[Custom Ping documentation](https://mozilla.github.io/glean/book/user/pings/custom.html#the-gleanrestarted-event).
send_in_pings:
- all-pings
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1716725
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1716725
data_sensitivity:
- technical
notification_emails:
expires: never