# 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
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
