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# This file defines the metrics that are recorded by the Glean SDK. They are
6# automatically converted to platform-specific code at build time using the
7# `glean_parser` PyPI package.
8
9# This file is for Internal FOG Test Use Only.
10
11---
12$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
13
14test_only:
15  bad_code:
16    type: counter
17    description: |
18      Number of times we encountered bad code.
19      This is a test-only metric.
20    bugs:
21      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
22    data_reviews:
23      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
24    data_sensitivity:
25      - technical
26    notification_emails:
27      - glean-team@mozilla.com
28    expires: never
29    send_in_pings:
30      - test-ping
31
32  can_we_time_it:
33    type: timespan
34    time_unit: nanosecond
35    description: |
36      Test metric for a timespan.
37      This is a test-only metric.
38    bugs:
39      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
40    data_reviews:
41      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
42    data_sensitivity:
43      - technical
44    notification_emails:
45      - glean-team@mozilla.com
46    expires: never
47    send_in_pings:
48      - test-ping
49
50  cheesy_string:
51    type: string
52    description: |
53      Only the cheesiest of strings.
54      This is a test-only metric.
55    bugs:
56      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673662
57    data_reviews:
58      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673662#c1
59    data_sensitivity:
60      - technical
61    notification_emails:
62      - glean-team@mozilla.com
63    expires: never
64    send_in_pings:
65      - test-ping
66
67  cheesy_string_list:
68    type: string_list
69    description: |
70      Only the cheesiest of strings. In list form!
71      This is a test-only metric.
72    bugs:
73      - https://bugzilla.mozilla.org/show_bug.cgi?id=1682960
74    data_reviews:
75      - https://bugzilla.mozilla.org/show_bug.cgi?id=1682960#c1
76    data_sensitivity:
77      - technical
78    notification_emails:
79      - glean-team@mozilla.com
80    expires: never
81    send_in_pings:
82      - test-ping
83
84  what_a_date:
85    type: datetime
86    time_unit: second
87    description: >
88      ...To be writing FOG code.
89      This is a test-only metric.
90    bugs:
91      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
92    data_reviews:
93      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
94    data_sensitivity:
95      - technical
96    notification_emails:
97      - glean-team@mozilla.com
98    expires: never
99    send_in_pings:
100      - test-ping
101
102  what_id_it:  # Using a different metrics yaml style for fun.
103    type: uuid
104    description: |
105      Just a UUID.
106      This is a test-only metric.
107    bugs: ["https://bugzilla.mozilla.org/show_bug.cgi?id=1673664"]
108    data_reviews: ["https://bugzilla.mozilla.org/show_bug.cgi?id=1673664#c1"]
109    data_sensitivity: ["technical"]
110    notification_emails: ["glean-team@mozilla.com"]
111    expires: never
112    send_in_pings: ["test-ping"]
113
114  can_we_flag_it:
115    type: boolean
116    description: |
117      Test metric for a boolean.
118      This is a test-only metric.
119    bugs:
120      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
121    data_reviews:
122      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
123    data_sensitivity:
124      - technical
125    notification_emails:
126      - glean-team@mozilla.com
127    expires: never
128    send_in_pings:
129      - test-ping
130
131  do_you_remember:
132    type: memory_distribution
133    memory_unit: megabyte
134    description: |
135      They say it's the second thing to go.
136      This is a test-only metric.
137    bugs:
138      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673648
139    data_reviews:
140      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673648#c1
141    data_sensitivity:
142      - technical
143    expires: never
144    notification_emails:
145      - glean-team@mozilla.com
146    send_in_pings:
147      - test-ping
148
149  what_time_is_it:
150    type: timing_distribution
151    time_unit: microsecond
152    description: |
153      Adheres to at least two of the top ten fallacies programmers believe
154      about time.
155      This is a test-only metric.
156    bugs:
157      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673663
158    data_reviews:
159      - https://bugzilla.mozilla.org/show_bug.cgi?id=1673663#c1
160    data_sensitivity:
161      - technical
162    expires: never
163    notification_emails:
164      - glean-team@mozilla.com
165    send_in_pings:
166      - test-ping
167
168  mabels_kitchen_counters:
169    type: labeled_counter
170    description: |
171      Counts Mabels labeled by their kitchen counters.
172      This is a test-only metric.
173    bugs:
174      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277
175    data_reviews:
176      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277#c1
177    data_sensitivity:
178      - technical
179    expires: never
180    notification_emails:
181      - glean-team@mozilla.com
182    send_in_pings:
183      - test-ping
184
185  mabels_bathroom_counters:
186    type: labeled_counter
187    description: |
188      Counts Mabels labeled by their bathroom counters.
189      This is a test-only metric.
190    bugs:
191      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683171
192    data_reviews:
193      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683171#c1
194    data_sensitivity:
195      - technical
196    expires: never
197    notification_emails:
198      - glean-team@mozilla.com
199    send_in_pings:
200      - test-ping
201
202  mabels_like_balloons:
203    type: labeled_boolean
204    description: |
205      Does the labeled Mabel like balloons?
206      This is a test-only metric.
207    bugs:
208      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277
209    data_reviews:
210      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277#c1
211    data_sensitivity:
212      - technical
213    expires: never
214    notification_emails:
215      - glean-team@mozilla.com
216    send_in_pings:
217      - test-ping
218
219  mabels_balloon_strings:
220    type: labeled_string
221    description: |
222      What do the labeled Mabel's liked balloons' strings say?
223      This is a test-only metric.
224    bugs:
225      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277
226    data_reviews:
227      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277#c1
228    data_sensitivity:
229      - technical
230    expires: never
231    notification_emails:
232      - glean-team@mozilla.com
233    send_in_pings:
234      - test-ping
235
236  mirror_time:
237    type: timespan
238    time_unit: nanosecond
239    description: |
240      Mirrored metric for a timespan.
241      This is a test-only metric.
242    bugs:
243      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
244    data_reviews:
245      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406#c1
246    data_sensitivity:
247      - technical
248    notification_emails:
249      - glean-team@mozilla.com
250    expires: never
251    send_in_pings:
252      - test-ping
253    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_TIMESPAN
254
255  mirror_time_nanos:
256    type: timespan
257    time_unit: nanosecond
258    description: |
259      Mirrored metric for a timespan.
260      This is a test-only metric.
261    bugs:
262      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704106
263    data_reviews:
264      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704106#c1
265    data_sensitivity:
266      - technical
267    notification_emails:
268      - glean-team@mozilla.com
269    expires: never
270    send_in_pings:
271      - test-ping
272    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_TIMESPAN_NANOS
273
274  mirrors_for_labeled_bools:
275    type: labeled_boolean
276    description: |
277      Mirrored metric.
278      This is a test-only metric.
279    bugs:
280      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277
281    data_reviews:
282      - https://bugzilla.mozilla.org/show_bug.cgi?id=1675277#c1
283    data_sensitivity:
284      - technical
285    expires: never
286    notification_emails:
287      - glean-team@mozilla.com
288    send_in_pings:
289      - test-ping
290    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_LABELED_BOOL
291
292  one_ping_one_bool:
293    type: boolean
294    description: |
295      One bool for one ping only.
296      This is a test-only metric.
297    bugs:
298      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685402
299    data_reviews:
300      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685402#c1
301    data_sensitivity:
302      - technical
303    expires: never
304    notification_emails:
305      - glean-team@mozilla.com
306    send_in_pings:
307      - one-ping-only
308
309  meaning_of_life:
310    type: quantity
311    unit: unfathomable
312    description: |
313      Measures the one true answer to the Ultimate Question of Life,
314      the Universe, and Everything.
315      Approximately.
316      This is a test-only metric.
317    bugs:
318      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704846
319    data_reviews:
320      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704846#c1
321    data_sensitivity:
322      - technical
323    expires: never
324    notification_emails:
325      - glean-team@mozilla.com
326    send_in_pings:
327      - test-ping
328    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_QUANTITY
329
330
331test_only.ipc:
332  a_counter:
333    type: counter
334    description: |
335      This is a test-only metric.
336      Just counting things.
337    bugs:
338      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
339      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
340    data_reviews:
341      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
342    data_sensitivity:
343      - technical
344    notification_emails:
345      - glean-team@mozilla.com
346    expires: never
347    send_in_pings:
348      - store1
349    no_lint:
350      - COMMON_PREFIX
351    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_COUNTER
352  a_bool:
353    type: boolean
354    description: |
355      This is a test-only metric.
356      Just flagging things.
357    bugs:
358      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
359      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
360    data_reviews:
361      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
362    data_sensitivity:
363      - technical
364    notification_emails:
365      - glean-team@mozilla.com
366    expires: never
367    send_in_pings:
368      - store1
369    no_lint:
370      - COMMON_PREFIX
371    telemetry_mirror: TELEMETRY_TEST_BOOLEAN_KIND
372  a_date:
373    type: datetime
374    time_unit: second
375    description: |
376      This is a test-only metric.
377      Just putting things on the calendar.
378    bugs:
379      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
380      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
381    data_reviews:
382      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
383    data_sensitivity:
384      - technical
385    notification_emails:
386      - glean-team@mozilla.com
387    expires: never
388    send_in_pings:
389      - store1
390    no_lint:
391      - COMMON_PREFIX
392    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_DATE
393  a_string:
394    type: string
395    description: |
396      This is a test-only metric.
397      Just setting some strings.
398    bugs:
399      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
400      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
401    data_reviews:
402      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
403    data_sensitivity:
404      - technical
405    notification_emails:
406      - glean-team@mozilla.com
407    expires: never
408    send_in_pings:
409      - store1
410    no_lint:
411      - COMMON_PREFIX
412    telemetry_mirror: TELEMETRY_TEST_MULTIPLE_STORES_STRING
413  a_memory_dist:
414    type: memory_distribution
415    memory_unit: kilobyte
416    description: |
417      This is a test-only metric.
418      Just measuring memory.
419    bugs:
420      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
421      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
422    data_reviews:
423      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
424    data_sensitivity:
425      - technical
426    notification_emails:
427      - glean-team@mozilla.com
428    expires: never
429    send_in_pings:
430      - store1
431    no_lint:
432      - COMMON_PREFIX
433    telemetry_mirror: TELEMETRY_TEST_LINEAR
434  a_timing_dist:
435    type: timing_distribution
436    description: |
437      This is a test-only metric.
438      Just measuring time.
439    bugs:
440      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
441      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
442    data_reviews:
443      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
444    data_sensitivity:
445      - technical
446    notification_emails:
447      - glean-team@mozilla.com
448    expires: never
449    send_in_pings:
450      - store1
451    no_lint:
452      - COMMON_PREFIX
453    telemetry_mirror: TELEMETRY_TEST_EXPONENTIAL
454  a_custom_dist:
455    type: custom_distribution
456    description: |
457      This is a test-only metric.
458      Just measuring samples.
459    bugs:
460      - https://bugzilla.mozilla.org/show_bug.cgi?id=1713398
461    data_reviews:
462      - https://bugzilla.mozilla.org/show_bug.cgi?id=1713398#c1
463    data_sensitivity:
464      - technical
465    notification_emails:
466      - glean-team@mozilla.com
467    expires: never
468    send_in_pings:
469      - store1
470    no_lint:
471      - COMMON_PREFIX
472    range_min: 1
473    range_max: 2147483646
474    bucket_count: 10
475    histogram_type: linear
476    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_CUSTOM
477  a_string_list:
478    type: string_list
479    description: |
480      This is a test-only metric.
481      Just appending some strings.
482    bugs:
483      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
484      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
485    data_reviews:
486      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
487    data_sensitivity:
488      - technical
489    notification_emails:
490      - glean-team@mozilla.com
491    expires: never
492    send_in_pings:
493      - store1
494    no_lint:
495      - COMMON_PREFIX
496    telemetry_mirror: TELEMETRY_TEST_KEYED_BOOLEAN_KIND
497  an_event:
498    type: event
499    extra_keys:
500      extra1:
501        type: string
502        description: "Some extra data"
503      extra2:
504        type: string
505        description: "Some extra data again"
506    description: |
507      This is a test-only metric.
508      Just recording some events.
509    bugs:
510      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
511      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
512    data_reviews:
513      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
514    data_sensitivity:
515      - technical
516    notification_emails:
517      - glean-team@mozilla.com
518    expires: never
519    send_in_pings:
520      - store1
521    no_lint:
522      - COMMON_PREFIX
523    telemetry_mirror: TelemetryTest_MirrorWithExtra_Object1
524  event_with_extra:
525    type: event
526    extra_keys:
527      extra1:
528        type: string
529        description: "Some extra data"
530      extra2:
531        type: quantity
532        description: "Some extra data again"
533      extra3_longer_name:
534        type: boolean
535        description: "Some extra data again. Also tests extras with underscores"
536    description: |
537      This is a test-only metric.
538      Just recording some events.
539    bugs:
540      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
541      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
542    data_reviews:
543      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
544    data_sensitivity:
545      - technical
546    notification_emails:
547      - glean-team@mozilla.com
548    expires: never
549    send_in_pings:
550      - store1
551    no_lint:
552      - COMMON_PREFIX
553  no_extra_event:
554    type: event
555    description: |
556      This is a test-only metric.
557      Just recording some events without the extra fuss.
558    bugs:
559      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
560      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
561    data_reviews:
562      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
563    data_sensitivity:
564      - technical
565    notification_emails:
566      - glean-team@mozilla.com
567    expires: never
568    send_in_pings:
569      - store1
570    telemetry_mirror: TelemetryTest_NotExpiredOptout_Object1
571  a_uuid:
572    type: uuid
573    description: |
574      This is a test-only metric.
575      Just recording some unique identifiers.
576    bugs:
577      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165
578      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
579    data_reviews:
580      - https://bugzilla.mozilla.org/show_bug.cgi?id=1646165#c1
581    data_sensitivity:
582      - technical
583    notification_emails:
584      - glean-team@mozilla.com
585    expires: never
586    send_in_pings:
587      - store1
588    no_lint:
589      - COMMON_PREFIX
590    telemetry_mirror: TELEMETRY_TEST_STRING_KIND
591  a_labeled_counter:
592    type: labeled_counter
593    description: |
594      This is a test-only metric.
595      Just counting labeled things.
596    bugs:
597      - https://bugzilla.mozilla.org/show_bug.cgi?id=1688281
598      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
599    data_reviews:
600      - https://bugzilla.mozilla.org/show_bug.cgi?id=1688281#c1
601    data_sensitivity:
602      - technical
603    notification_emails:
604      - glean-team@mozilla.com
605    expires: never
606    send_in_pings:
607      - store1
608    no_lint:
609      - COMMON_PREFIX
610    telemetry_mirror: TELEMETRY_TEST_ANOTHER_MIRROR_FOR_LABELED_COUNTER
611  another_labeled_counter:
612    type: labeled_counter
613    description: |
614      This is a test-only metric.
615      Just another metric counting labeled things.
616    bugs:
617      - https://bugzilla.mozilla.org/show_bug.cgi?id=1688281
618      - https://bugzilla.mozilla.org/show_bug.cgi?id=1685406
619      - https://bugzilla.mozilla.org/show_bug.cgi?id=1758795
620    data_reviews:
621      - https://bugzilla.mozilla.org/show_bug.cgi?id=1688281#c1
622    data_sensitivity:
623      - technical
624    notification_emails:
625      - glean-team@mozilla.com
626    expires: never
627    send_in_pings:
628      - store1
629    no_lint:
630      - COMMON_PREFIX
631    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_LABELED_COUNTER
632  a_quantity:
633    type: quantity
634    unit: squad
635    description: |
636      This is a test-only metric.
637      Just quantifying things.
638    bugs:
639      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704846
640    data_reviews:
641      - https://bugzilla.mozilla.org/show_bug.cgi?id=1704846#c1
642    data_sensitivity:
643      - technical
644    notification_emails:
645      - glean-team@mozilla.com
646    expires: never
647    send_in_pings:
648      - store1
649    no_lint:
650      - COMMON_PREFIX
651  irate:
652    type: rate
653    description: |
654      This is a test-only metric.
655      A rate that isn't happy about it.
656    bugs:
657      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496
658    data_reviews:
659      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496#c1
660    data_sensitivity:
661      - technical
662    notification_emails:
663      - glean-team@mozilla.com
664    expires: never
665    send_in_pings:
666      - store1
667    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_RATE
668  rate_with_external_denominator:
669    type: rate
670    denominator_metric: test_only.ipc.an_external_denominator
671    description: |
672      This is a test-only metric.
673      A rate with a denominator that is Out There.
674    bugs:
675      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496
676    data_reviews:
677      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496#c1
678    data_sensitivity:
679      - technical
680    notification_emails:
681      - glean-team@mozilla.com
682    expires: never
683    send_in_pings:
684      - store1
685  an_external_denominator:
686    type: counter
687    description: |
688      This is a test-only metric.
689      A denominator not from around here.
690    bugs:
691      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496
692    data_reviews:
693      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694496#c1
694    data_sensitivity:
695      - technical
696    notification_emails:
697      - glean-team@mozilla.com
698    expires: never
699    send_in_pings:
700      - store1
701    no_lint:
702      - COMMON_PREFIX
703