metrics.yaml (16641B)
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 # Adding a new metric? We have docs for that! 6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html 7 8 --- 9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0 10 $tags: 11 - 'Firefox :: Session Restore' 12 13 session_restore: 14 backup_can_be_loaded_session_file: 15 type: event 16 description: > 17 Recorded when a file is able to be successfully read on startup 18 This event was generated to correspond to the Legacy Telemetry event 19 session_restore.backup_can_be_loaded#session_file. 20 bugs: 21 - https://bugzil.la/1874742 22 data_reviews: 23 - https://bugzil.la/1874742 24 notification_emails: 25 - session-restore-telemetry-alerts@mozilla.com 26 expires: never 27 extra_keys: 28 can_load: 29 description: > 30 Whether or not the startup file can be read/loaded 31 type: string 32 path_key: 33 description: > 34 A symbolic name for the backup file, should be one of "clean", "recovery", "recoveryBackup", "cleanBackup", or "upgradeBackup" 35 type: string 36 loadfail_reason: 37 description: > 38 Reason why the file cannot be loaded, N/A if can be loaded 39 type: string 40 telemetry_mirror: Session_restore_BackupCanBeLoaded_SessionFile 41 42 shutdown_success_session_startup: 43 type: event 44 description: > 45 Report shutdown success 46 This event was generated to correspond to the Legacy Telemetry event 47 session_restore.shutdown_success#session_startup. 48 bugs: 49 - https://bugzil.la/1874742 50 data_reviews: 51 - https://bugzil.la/1874742 52 notification_emails: 53 - session-restore-telemetry-alerts@mozilla.com 54 expires: never 55 extra_keys: 56 shutdown_ok: 57 description: > 58 Whether or not the shutdown happened successfully, unsuccessful if previous session crashed 59 type: string 60 shutdown_reason: 61 description: > 62 Reason why shutdown didn't happen successfully, N/A if previous session didn't crashed 63 type: string 64 telemetry_mirror: Session_restore_ShutdownSuccess_SessionStartup 65 66 shutdown_flush_all_outcomes: 67 type: labeled_counter 68 description: > 69 The count of time-outs, abnormal shutdown and frameloader crashes observed during an async shutdown 70 labels: 71 - "timed_out" 72 - "abnormal_content_shutdown" 73 - "oop_frameloader_crashed" 74 - "complete" 75 bugs: 76 - https://bugzilla.mozilla.org/show_bug.cgi?id=1903112 77 data_reviews: 78 - https://bugzilla.mozilla.org/show_bug.cgi?id=1903112 79 notification_emails: 80 - session-restore-telemetry-alerts@mozilla.com 81 expires: never 82 83 shutdown_type: 84 type: labeled_counter 85 description: > 86 On quit-application-granted, is the shutdown sync (immediate) or async 87 labels: 88 - "sync" 89 - "async" 90 bugs: 91 - https://bugzilla.mozilla.org/show_bug.cgi?id=1903112 92 data_reviews: 93 - https://bugzilla.mozilla.org/show_bug.cgi?id=1903112 94 notification_emails: 95 - session-restore-telemetry-alerts@mozilla.com 96 expires: never 97 98 startup_init_session: 99 type: timing_distribution 100 description: > 101 Session restore: Time it takes to prepare the data structures for 102 restoring a session (ms) 103 104 This metric was generated to correspond to the Legacy Telemetry 105 exponential histogram FX_SESSION_RESTORE_STARTUP_INIT_SESSION_MS. 106 time_unit: millisecond 107 bugs: 108 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 109 data_reviews: 110 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 111 notification_emails: 112 - session-restore-telemetry-alerts@mozilla.com 113 expires: never 114 telemetry_mirror: FX_SESSION_RESTORE_STARTUP_INIT_SESSION_MS 115 116 startup_onload_initial_window: 117 type: timing_distribution 118 description: > 119 Session restore: Time it takes to finish restoration once we have first 120 opened a window (ms) 121 122 This metric was generated to correspond to the Legacy Telemetry 123 exponential histogram FX_SESSION_RESTORE_STARTUP_ONLOAD_INITIAL_WINDOW_MS. 124 time_unit: millisecond 125 bugs: 126 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 127 data_reviews: 128 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 129 notification_emails: 130 - session-restore-telemetry-alerts@mozilla.com 131 expires: never 132 telemetry_mirror: FX_SESSION_RESTORE_STARTUP_ONLOAD_INITIAL_WINDOW_MS 133 134 collect_all_windows_data: 135 type: timing_distribution 136 description: > 137 Session restore: Time to collect all window data (ms) 138 139 This metric was generated to correspond to the Legacy Telemetry 140 exponential histogram FX_SESSION_RESTORE_COLLECT_ALL_WINDOWS_DATA_MS. 141 time_unit: millisecond 142 bugs: 143 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 144 data_reviews: 145 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 146 notification_emails: 147 - session-restore-telemetry-alerts@mozilla.com 148 expires: never 149 telemetry_mirror: FX_SESSION_RESTORE_COLLECT_ALL_WINDOWS_DATA_MS 150 151 collect_data: 152 type: timing_distribution 153 description: > 154 Session restore: Time to collect all window and tab data (ms) 155 156 This metric was generated to correspond to the Legacy Telemetry 157 exponential histogram FX_SESSION_RESTORE_COLLECT_DATA_MS. 158 time_unit: millisecond 159 bugs: 160 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 161 data_reviews: 162 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 163 notification_emails: 164 - session-restore-telemetry-alerts@mozilla.com 165 expires: never 166 telemetry_mirror: FX_SESSION_RESTORE_COLLECT_DATA_MS 167 168 collect_session_history: 169 type: timing_distribution 170 description: > 171 Session restore: Duration of session history collection in the parent 172 process (ms). 173 174 This metric was generated to correspond to the Legacy Telemetry 175 exponential histogram FX_SESSION_RESTORE_COLLECT_SESSION_HISTORY_MS. 176 time_unit: millisecond 177 bugs: 178 - https://bugzilla.mozilla.org/show_bug.cgi?id=1810704 179 data_reviews: 180 - https://bugzilla.mozilla.org/show_bug.cgi?id=1810704 181 notification_emails: 182 - session-restore-telemetry-alerts@mozilla.com 183 - farre@mozilla.com 184 expires: never 185 telemetry_mirror: FX_SESSION_RESTORE_COLLECT_SESSION_HISTORY_MS 186 187 read_file: 188 type: timing_distribution 189 description: > 190 Session restore: Time to read the session data from the file on disk (ms) 191 192 This metric was generated to correspond to the Legacy Telemetry 193 exponential histogram FX_SESSION_RESTORE_READ_FILE_MS. 194 time_unit: millisecond 195 bugs: 196 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 197 data_reviews: 198 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 199 notification_emails: 200 - session-restore-telemetry-alerts@mozilla.com 201 expires: never 202 telemetry_mirror: FX_SESSION_RESTORE_READ_FILE_MS 203 204 write_file: 205 type: timing_distribution 206 description: > 207 Session restore: Time to write the session data to the file on disk (ms) 208 209 This metric was generated to correspond to the Legacy Telemetry 210 exponential histogram FX_SESSION_RESTORE_WRITE_FILE_MS. 211 time_unit: millisecond 212 bugs: 213 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 214 data_reviews: 215 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 216 notification_emails: 217 - session-restore-telemetry-alerts@mozilla.com 218 expires: never 219 telemetry_mirror: FX_SESSION_RESTORE_WRITE_FILE_MS 220 221 file_size_bytes: 222 type: memory_distribution 223 description: > 224 Session restore: The size of file sessionstore.js (bytes) 225 226 This metric was generated to correspond to the Legacy Telemetry 227 exponential histogram FX_SESSION_RESTORE_FILE_SIZE_BYTES. 228 memory_unit: byte 229 bugs: 230 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 231 data_reviews: 232 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 233 notification_emails: 234 - session-restore-telemetry-alerts@mozilla.com 235 expires: never 236 telemetry_mirror: FX_SESSION_RESTORE_FILE_SIZE_BYTES 237 238 corrupt_file: 239 type: labeled_counter 240 description: > 241 Session restore: Whether the file read on startup contained parse-able 242 JSON 243 244 This metric was generated to correspond to the Legacy Telemetry boolean 245 histogram FX_SESSION_RESTORE_CORRUPT_FILE. 246 labels: 247 - "false" 248 - "true" 249 bugs: 250 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 251 data_reviews: 252 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 253 notification_emails: 254 - session-restore-telemetry-alerts@mozilla.com 255 expires: never 256 telemetry_mirror: h#FX_SESSION_RESTORE_CORRUPT_FILE 257 258 all_files_corrupt: 259 type: labeled_counter 260 description: > 261 Session restore: Whether none of the backup files contained parse-able 262 JSON 263 264 This metric was generated to correspond to the Legacy Telemetry boolean 265 histogram FX_SESSION_RESTORE_ALL_FILES_CORRUPT. 266 labels: 267 - "false" 268 - "true" 269 bugs: 270 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 271 data_reviews: 272 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 273 notification_emails: 274 - session-restore-telemetry-alerts@mozilla.com 275 expires: never 276 telemetry_mirror: h#FX_SESSION_RESTORE_ALL_FILES_CORRUPT 277 278 restore_window: 279 type: timing_distribution 280 description: > 281 Session restore: Time spent blocking the main thread while restoring a 282 window state (ms) 283 284 This metric was generated to correspond to the Legacy Telemetry 285 exponential histogram FX_SESSION_RESTORE_RESTORE_WINDOW_MS. 286 time_unit: millisecond 287 bugs: 288 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 289 data_reviews: 290 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 291 notification_emails: 292 - session-restore-telemetry-alerts@mozilla.com 293 expires: never 294 telemetry_mirror: FX_SESSION_RESTORE_RESTORE_WINDOW_MS 295 296 auto_restore_duration_until_eager_tabs_restored: 297 type: timing_distribution 298 description: > 299 Session restore: If the browser is setup to auto-restore tabs, this probe 300 measures the time elapsed between the instant we start Session Restore and 301 the instant we have finished restoring tabs eagerly. At this stage, the 302 tabs that are restored on demand are not restored yet. 303 304 This metric was generated to correspond to the Legacy Telemetry 305 exponential histogram 306 FX_SESSION_RESTORE_AUTO_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS. 307 time_unit: millisecond 308 bugs: 309 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 310 data_reviews: 311 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 312 notification_emails: 313 - session-restore-telemetry-alerts@mozilla.com 314 expires: never 315 telemetry_mirror: FX_SESSION_RESTORE_AUTO_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS 316 317 manual_restore_duration_until_eager_tabs_restored: 318 type: timing_distribution 319 description: > 320 Session restore: If a session is restored by the user clicking on 'Restore 321 Session', this probe measures the time elapsed between the instant the 322 user has clicked and the instant we have finished restoring tabs eagerly. 323 At this stage, the tabs that are restored on demand are not restored yet. 324 325 This metric was generated to correspond to the Legacy Telemetry 326 exponential histogram 327 FX_SESSION_RESTORE_MANUAL_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS. 328 time_unit: millisecond 329 bugs: 330 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 331 data_reviews: 332 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 333 notification_emails: 334 - session-restore-telemetry-alerts@mozilla.com 335 expires: never 336 telemetry_mirror: FX_SESSION_RESTORE_MANUAL_RESTORE_DURATION_UNTIL_EAGER_TABS_RESTORED_MS 337 338 number_of_tabs_restored: 339 type: custom_distribution 340 description: > 341 Session restore: Number of tabs in the session that has just been 342 restored. 343 344 This metric was generated to correspond to the Legacy Telemetry 345 exponential histogram FX_SESSION_RESTORE_NUMBER_OF_TABS_RESTORED. 346 range_min: 1 347 range_max: 500 348 bucket_count: 20 349 histogram_type: exponential 350 unit: tabs 351 bugs: 352 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 353 data_reviews: 354 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 355 notification_emails: 356 - session-restore-telemetry-alerts@mozilla.com 357 expires: never 358 telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_TABS_RESTORED 359 360 number_of_windows_restored: 361 type: custom_distribution 362 description: > 363 Session restore: Number of windows in the session that has just been 364 restored. 365 366 This metric was generated to correspond to the Legacy Telemetry enumerated 367 histogram FX_SESSION_RESTORE_NUMBER_OF_WINDOWS_RESTORED. 368 range_min: 0 369 range_max: 50 370 bucket_count: 51 371 histogram_type: linear 372 bugs: 373 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 374 data_reviews: 375 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 376 notification_emails: 377 - session-restore-telemetry-alerts@mozilla.com 378 expires: never 379 telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_WINDOWS_RESTORED 380 381 number_of_eager_tabs_restored: 382 type: custom_distribution 383 description: > 384 Session restore: Number of tabs restored eagerly in the session that has 385 just been restored. 386 387 This metric was generated to correspond to the Legacy Telemetry enumerated 388 histogram FX_SESSION_RESTORE_NUMBER_OF_EAGER_TABS_RESTORED. 389 range_min: 0 390 range_max: 50 391 bucket_count: 51 392 histogram_type: linear 393 bugs: 394 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 395 data_reviews: 396 - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631 397 notification_emails: 398 - session-restore-telemetry-alerts@mozilla.com 399 expires: never 400 telemetry_mirror: FX_SESSION_RESTORE_NUMBER_OF_EAGER_TABS_RESTORED 401 402 shutdown_ok: 403 type: labeled_counter 404 description: > 405 Did the browser start after a successful shutdown 406 407 This metric was generated to correspond to the Legacy Telemetry boolean 408 histogram SHUTDOWN_OK. 409 labels: 410 - "false" 411 - "true" 412 bugs: 413 - https://bugzilla.mozilla.org/show_bug.cgi?id=1421688 414 data_reviews: 415 - https://bugzilla.mozilla.org/show_bug.cgi?id=1421688 416 notification_emails: 417 - chutten@mozilla.com 418 expires: never 419 telemetry_mirror: h#SHUTDOWN_OK 420 421 startup_timeline: 422 type: labeled_quantity 423 unit: milliseconds since process creation 424 lifetime: application 425 description: | 426 Events on the startup timeline, in millis since process creation. 427 Previously carried in Legacy "main" ping `simpleMeasurements`. 428 bugs: 429 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 430 data_reviews: 431 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 432 notification_emails: 433 - sfoster@mozilla.com 434 - session-restore-telemetry-alerts@mozilla.com 435 expires: never 436 data_sensitivity: 437 - technical 438 labels: 439 - sessionRestoreInitialized 440 - sessionRestoreRestoring 441 442 browser.engagement: 443 sessionrestore_interstitial: 444 type: labeled_counter 445 description: > 446 Whether we show about:sessionrestore or not. Split by key, which 447 indicates why we showed the item or not. Specifically, 448 'deferred_restore' means we didn't autorestore and thus didn't show 449 the interstitial; 'autorestore' indicates we autorestored without 450 showing the interstitial. 'shown_old_session', 451 'shown_only_about_welcomeback', 'shown_many_crashes', 452 'shown_many_crashes_old_session' all indicate we did show the 453 interstitial because of a crash, and the text after 'shown' 454 indicates what secondary reason there was to show this page (as we 455 don't show it for 'just' one crash). 456 This metric was generated to correspond to the Legacy Telemetry 457 scalar browser.engagement.sessionrestore_interstitial. 458 bugs: 459 - https://bugzil.la/1671271 460 data_reviews: 461 - https://bugzil.la/1671271 462 notification_emails: 463 - gijs@mozilla.com 464 expires: never 465 telemetry_mirror: BROWSER_ENGAGEMENT_SESSIONRESTORE_INTERSTITIAL