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
|
# 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:
- 'Firefox :: Session Restore'
session_restore:
backup_can_be_loaded_session_file:
type: event
description: >
Recorded when a file is able to be successfully read on startup
This event was generated to correspond to the Legacy Telemetry event
session_restore.backup_can_be_loaded#session_file.
bugs:
- https://bugzil.la/1874742
data_reviews:
- https://bugzil.la/1874742
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
extra_keys:
can_load:
description: >
Whether or not the startup file can be read/loaded
type: string
path_key:
description: >
A symbolic name for the backup file, should be one of "clean", "recovery", "recoveryBackup", "cleanBackup", or "upgradeBackup"
type: string
loadfail_reason:
description: >
Reason why the file cannot be loaded, N/A if can be loaded
type: string
telemetry_mirror: Session_restore_BackupCanBeLoaded_SessionFile
shutdown_success_session_startup:
type: event
description: >
Report shutdown success
This event was generated to correspond to the Legacy Telemetry event
session_restore.shutdown_success#session_startup.
bugs:
- https://bugzil.la/1874742
data_reviews:
- https://bugzil.la/1874742
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
extra_keys:
shutdown_ok:
description: >
Whether or not the shutdown happened successfully, unsuccessful if previous session crashed
type: string
shutdown_reason:
description: >
Reason why shutdown didn't happen successfully, N/A if previous session didn't crashed
type: string
telemetry_mirror: Session_restore_ShutdownSuccess_SessionStartup
startup_init_session:
type: timing_distribution
description: >
Session restore: Time it takes to prepare the data structures for
restoring a session (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_STARTUP_INIT_SESSION_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_STARTUP_INIT_SESSION_MS
startup_onload_initial_window:
type: timing_distribution
description: >
Session restore: Time it takes to finish restoration once we have first
opened a window (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_STARTUP_ONLOAD_INITIAL_WINDOW_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_STARTUP_ONLOAD_INITIAL_WINDOW_MS
collect_all_windows_data:
type: timing_distribution
description: >
Session restore: Time to collect all window data (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_COLLECT_ALL_WINDOWS_DATA_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_COLLECT_ALL_WINDOWS_DATA_MS
collect_data:
type: timing_distribution
description: >
Session restore: Time to collect all window and tab data (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_COLLECT_DATA_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_COLLECT_DATA_MS
collect_session_history:
type: timing_distribution
description: >
Session restore: Duration of session history collection in the parent
process (ms).
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_COLLECT_SESSION_HISTORY_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1810704
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1810704
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
- farre@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_COLLECT_SESSION_HISTORY_MS
read_file:
type: timing_distribution
description: >
Session restore: Time to read the session data from the file on disk (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_READ_FILE_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_READ_FILE_MS
write_file:
type: timing_distribution
description: >
Session restore: Time to write the session data to the file on disk (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_WRITE_FILE_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_WRITE_FILE_MS
file_size_bytes:
type: memory_distribution
description: >
Session restore: The size of file sessionstore.js (bytes)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_FILE_SIZE_BYTES.
memory_unit: byte
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_FILE_SIZE_BYTES
corrupt_file:
type: labeled_counter
description: >
Session restore: Whether the file read on startup contained parse-able
JSON
This metric was generated to correspond to the Legacy Telemetry boolean
histogram FX_SESSION_RESTORE_CORRUPT_FILE.
labels:
- "false"
- "true"
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: h#FX_SESSION_RESTORE_CORRUPT_FILE
all_files_corrupt:
type: labeled_counter
description: >
Session restore: Whether none of the backup files contained parse-able
JSON
This metric was generated to correspond to the Legacy Telemetry boolean
histogram FX_SESSION_RESTORE_ALL_FILES_CORRUPT.
labels:
- "false"
- "true"
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: h#FX_SESSION_RESTORE_ALL_FILES_CORRUPT
restore_window:
type: timing_distribution
description: >
Session restore: Time spent blocking the main thread while restoring a
window state (ms)
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_RESTORE_WINDOW_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_RESTORE_WINDOW_MS
auto_restore_duration_until_eager_tabs_restored:
type: timing_distribution
description: >
Session restore: If the browser is setup to auto-restore tabs, this probe
measures the time elapsed between the instant we start Session Restore and
the instant we have finished restoring tabs eagerly. At this stage, the
tabs that are restored on demand are not restored yet.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram
FX_SESSION_RESTORE_AUTO_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_AUTO_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS
manual_restore_duration_until_eager_tabs_restored:
type: timing_distribution
description: >
Session restore: If a session is restored by the user clicking on 'Restore
Session', this probe measures the time elapsed between the instant the
user has clicked and the instant we have finished restoring tabs eagerly.
At this stage, the tabs that are restored on demand are not restored yet.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram
FX_SESSION_RESTORE_MANUAL_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_MANUAL_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS
number_of_tabs_restored:
type: custom_distribution
description: >
Session restore: Number of tabs in the session that has just been
restored.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_SESSION_RESTORE_NUMBER_OF_TABS_RESTORED.
range_min: 1
range_max: 500
bucket_count: 20
histogram_type: exponential
unit: tabs
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_TABS_RESTORED
number_of_windows_restored:
type: custom_distribution
description: >
Session restore: Number of windows in the session that has just been
restored.
This metric was generated to correspond to the Legacy Telemetry enumerated
histogram FX_SESSION_RESTORE_NUMBER_OF_WINDOWS_RESTORED.
range_min: 0
range_max: 50
bucket_count: 51
histogram_type: linear
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_WINDOWS_RESTORED
number_of_eager_tabs_restored:
type: custom_distribution
description: >
Session restore: Number of tabs restored eagerly in the session that has
just been restored.
This metric was generated to correspond to the Legacy Telemetry enumerated
histogram FX_SESSION_RESTORE_NUMBER_OF_EAGER_TABS_RESTORED.
range_min: 0
range_max: 50
bucket_count: 51
histogram_type: linear
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
notification_emails:
- session-restore-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_EAGER_TABS_RESTORED
shutdown_ok:
type: labeled_counter
description: >
Did the browser start after a successful shutdown
This metric was generated to correspond to the Legacy Telemetry boolean
histogram SHUTDOWN_OK.
labels:
- "false"
- "true"
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1421688
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1421688
notification_emails:
- chutten@mozilla.com
expires: never
telemetry_mirror: h#SHUTDOWN_OK
browser.engagement:
sessionrestore_interstitial:
type: labeled_counter
description: >
Whether we show about:sessionrestore or not. Split by key, which
indicates why we showed the item or not. Specifically,
'deferred_restore' means we didn't autorestore and thus didn't show
the interstitial; 'autorestore' indicates we autorestored without
showing the interstitial. 'shown_old_session',
'shown_only_about_welcomeback', 'shown_many_crashes',
'shown_many_crashes_old_session' all indicate we did show the
interstitial because of a crash, and the text after 'shown'
indicates what secondary reason there was to show this page (as we
don't show it for 'just' one crash).
This metric was generated to correspond to the Legacy Telemetry
scalar browser.engagement.sessionrestore_interstitial.
bugs:
- https://bugzil.la/1671271
data_reviews:
- https://bugzil.la/1671271
notification_emails:
- gijs@mozilla.com
expires: never
telemetry_mirror: BROWSER_ENGAGEMENT_SESSIONRESTORE_INTERSTITIAL
|
