forked from mozilla/glean
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metrics.yaml
336 lines (314 loc) · 9.64 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
# 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 Kotlin code at build time using the `glean_parser`
# PyPI package.
---
$schema: moz://mozilla.org/schemas/glean/metrics/1-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
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
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
notification_emails:
expires: never
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
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
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
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
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").
For language bindings that provide automatic detection for this value,
(e.g. Android/Kotlin), in the unlikely event that the build identifier
can not be retrieved from the OS, it is set to "inaccessible". For other
language bindings, 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
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").
In the unlikely event that the display version can not be retrieved,
it is set to "inaccessible".
bugs:
- https://bugzilla.mozilla.org/1508305
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1508305#c9
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
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
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
notification_emails:
expires: never
ping_reason:
type: string
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
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
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
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
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 overflew.
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
notification_emails:
expires: never
send_in_pings:
- all-pings
no_lint:
- COMMON_PREFIX
preinit_tasks_overflow:
type: counter
description:
The number of tasks queued in the pre-initialization buffer.
Only sent if the buffer overflows.
unit:
tasks
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1609482
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1609482#c3
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX
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
notification_emails:
expires: never
no_lint:
- COMMON_PREFIX