summaryrefslogtreecommitdiffstats
path: root/toolkit/mozapps/update/metrics.yaml
blob: e262fb0dd3e7f5736d28406ffc640c14392b6a7e (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
433
434
435
436
437
438
439
440
# 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/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - "Toolkit :: Application Update"

background_update:
  client_id:
    type: uuid
    description: >
      The legacy Telemetry client ID of this installation's default profile.

      The default profile is as determined by the Profile Service, namely
      `nsIToolkitProfileService.defaultProfile`.  The majority of users have
      only one Firefox installation and only one profile, so the default profile
      is their regular browsing profile.

      It is possible for a Firefox installation to not have a default profile,
      but in such cases the background update task will abort before sending any
      telemetry; therefore, the legacy Telemetry client ID should always be
      present.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1794053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1794053
    data_sensitivity:
      - highly_sensitive
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    no_lint:
      - BASELINE_PING
    send_in_pings:
      - background-update
      - metrics
      - events
      - baseline

  targeting_exists:
    type: boolean
    description: >
      True if the default profile had a targeting snapshot serialized to disk,
      and there was no exception thrown reading it.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  targeting_exception:
    type: boolean
    description: >
      True if the default profile had a targeting snapshot serialized to disk,
      but an exception was thrown reading it.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  targeting_version:
    type: quantity
    unit: version number
    description: >
      If the default profile had a targeting snapshot serialized to disk, the
      `version` of the snapshot.

      This version number does not have a physical unit: it's only useful to
      compare between versions.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  targeting_env_firefox_version:
    type: quantity
    unit: version number
    description: >
      The `environment.firefoxVersion` of the default profile's serialized
      targeting snapshot.  At the time of writing, this version is an integer
      representing the Firefox major version, e.g., `109`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - interaction
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  targeting_env_current_date:
    type: datetime
    time_unit: day
    description: >
      The `environment.currentDate` of the default profile's serialized
      targeting snapshot.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - interaction
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  targeting_env_profile_age:
    type: datetime
    time_unit: day
    description: >
      The `environment.profileAgeCreated` of the default profile's serialized
      targeting snapshot.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795467
    data_sensitivity:
      - interaction
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  final_state:
    type: string
    description: >
      String description of the final state the update state machine reached.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  states:
    type: string_list
    description: >
      Ordered list of string descriptions of the states that the update state
      machine reached.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  reasons:
    type: string_list
    description: >
      List of reasons that the background update task did not run.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  automatic_restart_attempted:
    type: boolean
    description: >
      True if the background update task successfully attempted an automatic restart.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847099
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847099#c3
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  automatic_restart_success:
    type: boolean
    description: >
      True if the background update task successfully restarted after
      an automatic restart.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847099
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847099#c3
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  exit_code_success:
    type: boolean
    description: >
      True if the exit code/status of the background update task is 0, which
      means success.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  exit_code_exception:
    type: boolean
    description: >
      True if the exit code/status of the background update task is 3, which
      means an exception was thrown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

update:
  service_enabled:
    type: boolean
    description: >
      Preference "app.update.service.enabled": whether the Mozilla Maintenance
      Service is enabled.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  auto_download:
    type: boolean
    description: >
      Per-installation preference "app.update.auto": whether to fetch and
      install updates without user intervention.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  background_update:
    type: boolean
    description: >
      Per-installation preference "app.update.background.enabled": whether to
      fetch and install updates in the background when Firefox is not running.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  enabled:
    type: boolean
    description: >
      True when policies are disabled or when the "DisableAppUpdate" is not in
      effect.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  channel:
    type: string
    description: >
      The update channel.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  can_usually_apply_updates:
    type: boolean
    description: >
      Whether or not the Update Service can usually download and install
      updates.
      See `canUsuallyApplyUpdates` in
      https://searchfox.org/mozilla-central/source/toolkit/mozapps/update/nsIUpdateService.idl.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  can_usually_check_for_updates:
    type: boolean
    description: >
      Whether or not the Update Service can usually check for updates.
      See `canUsuallyCheckForUpdates` in
      https://searchfox.org/mozilla-central/source/toolkit/mozapps/update/nsIUpdateService.idl.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  can_usually_stage_updates:
    type: boolean
    description: >
      Whether the Update Service is usually able to stage updates.
      See `canUsuallyStageUpdates` in
      https://searchfox.org/mozilla-central/source/toolkit/mozapps/update/nsIUpdateService.idl.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update

  can_usually_use_bits:
    type: boolean
    description: >
      On Windows, whether the Update Service can usually use BITS.
      See `canUsuallyUseBits` in
      https://searchfox.org/mozilla-central/source/toolkit/mozapps/update/nsIUpdateService.idl.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703318#c17
    data_sensitivity:
      - technical
    notification_emails:
      - install-update@mozilla.com
    expires: never
    send_in_pings:
      - background-update