summaryrefslogtreecommitdiffstats
path: root/toolkit/components/glean/tests/pytest/metrics_test.yaml
blob: 2bdcd1877fc1a1f1d20b2e32ea413081cda3149c (plain)
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
# 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. They are
# automatically converted to platform-specific code at build time using the
# `glean_parser` PyPI package.

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

test:
  boolean_metric:
    type: boolean
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_BOOL_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  labeled_boolean_metric:
    type: labeled_boolean
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_KEYED_BOOL_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  labeled_boolean_metric_labels:
    type: labeled_boolean
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    labels:
      - one_label
      - two_labels
      - three_labels
      - four_labels
      - five_labels
      - six_labels
      - seven_labels
      - eight_labels
      - nine_labels
      - ten_labels
    telemetry_mirror: SOME_OTHER_KEYED_BOOL_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  counter_metric:
    type: counter
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_UINT_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  labeled_counter_metric:
    type: labeled_counter
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_KEYED_UINT_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  labeled_counter_metric_labels:
    type: labeled_counter
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    labels:
      - one_label
      - two_labels
    telemetry_mirror: SOME_OTHER_KEYED_UINT_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  string_metric:
    type: string
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_STRING_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  labeled_string_metric:
    type: labeled_string
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com

  labeled_string_metric_labels:
    type: labeled_string
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    labels:
      - one_label
      - two_labels

  string_list_metric:
    type: string_list
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: YET_ANOTHER_KEYED_BOOL_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  text_metric:
    type: text
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1828528
    data_reviews:
      - https://example.com


  timespan_metric:
    type: timespan
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_OTHER_UINT_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  timing_distribution_metric:
    type: timing_distribution
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_TIME_HISTOGRAM_MS

  memory_distribution_metric:
    type: memory_distribution
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    memory_unit: kilobyte
    telemetry_mirror: SOME_MEM_HISTOGRAM_KB

  custom_distribution_metric:
    type: custom_distribution
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    range_min: 0
    range_max: 100
    bucket_count: 100
    histogram_type: linear
    telemetry_mirror: SOME_LINEAR_HISTOGRAM

test.nested:
  uuid_metric:
    type: uuid
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_OTHER_STRING_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  datetime_metric:
    type: datetime
    expires: never
    description: |
      A multi-line
      description
    lifetime: application
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: SOME_STILL_OTHER_STRING_SCALAR
    no_lint:
      - GIFFT_NON_PING_LIFETIME

  event_metric:
    type: event
    expires: never
    description: |
      A multi-line
      description
    lifetime: ping
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    telemetry_mirror: EventMetric_EnumNames_AreStrange

  event_metric_with_extra:
    type: event
    expires: never
    description: |
      A multi-line
      description
    lifetime: ping
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com
    extra_keys:
      an_extra_key:
        type: string
        description: An extra key description
      another_extra_key:
        type: string
        description: Another extra key description
    telemetry_mirror: EventMetric_EnumName_WithExtra

  quantity_metric:
    type: quantity
    unit: someunit
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1704846/
    data_reviews:
      - https://example.com
    telemetry_mirror: TELEMETRY_TEST_MIRROR_FOR_QUANTITY

  rate_metric:
    type: rate
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1704846/
    data_reviews:
      - https://example.com

  rate_with_external_denominator:
    type: rate
    denominator_metric: test.nested.external_denominator
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1704846/
    data_reviews:
      - https://example.com

  external_denominator:
    type: counter
    expires: never
    description: |
      A multi-line
      description
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1704846/
    data_reviews:
      - https://example.com

  optimizable_counter_metric:
    type: counter
    expires: never
    description: |
      A multi-line
      description
    lifetime: ping
    notification_emails:
      - glean-team@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/1635260/
    data_reviews:
      - https://example.com

  an_object:
    type: object
    description: An example object
    bugs:
      - https://bugzilla.mozilla.org/1839640
    data_reviews:
      - http://example.com/reviews
    notification_emails:
      - CHANGE-ME@example.com
    expires: never
    structure:
      type: array
      items:
        type: object
        properties:
          colour:
            type: string
          diameter:
            type: number