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/.
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
9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
11 - 'Firefox :: General'
13 browser.launched_to_handle:
17 Recorded when Firefox launches to complete a native notification popped by
18 a system (chrome privileged) alert. Windows-only at the time of writing.
20 - https://bugzilla.mozilla.org/show_bug.cgi?id=1788960
22 - https://bugzilla.mozilla.org/show_bug.cgi?id=1788960#c10
26 - nalexander@mozilla.com
27 - rtestard@mozilla.com
32 The `name` of the system (chrome privileged) alert that Firefox was
37 The `action` of the system (chrome privileged) alert that Firefox was
40 telemetry_mirror: BrowserLaunched_to_handle_SystemNotification_Toast
43 reasons_to_not_update:
46 Records which error was causing the background updater to fail.
47 This list supercedes the `background-update.reason` in
48 `mozapps/update/metrics.yaml`
50 - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
52 - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
56 - install-update@mozilla.com
63 time_last_update_scheduled:
67 Last time the background update was triggered.
69 - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
71 - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
75 - install-update@mozilla.com
83 manually_unpinned_since_last_launch:
86 Records whether Firefox has been unpinned from the Windows start menu
87 since last launch. This will only be recorded on MSIX due to the
88 underlying API only being available for packaged applications.
90 - https://bugzilla.mozilla.org/show_bug.cgi?id=1900035
92 - https://bugzilla.mozilla.org/show_bug.cgi?id=1900035
96 - install-update@mozilla.com
106 Records whether TLS key logging has been enabled via the environment
107 variable SSLKEYLOGFILE.
109 - https://bugzilla.mozilla.org/show_bug.cgi?id=1918455
111 - https://bugzilla.mozilla.org/show_bug.cgi?id=1918455
115 - dkeeler@mozilla.com
119 last_profile_disable_startup:
122 Recorded when Launch on login is disabled because the start with
123 last profile setting has been disabled.
124 This event was generated to correspond to the Legacy Telemetry event
125 launch_on_login.last_profile_disable#startup.
127 - https://bugzil.la/1858223
129 - https://bugzil.la/1858223
131 - nalexander@mozilla.com
133 telemetry_mirror: Launch_on_login_LastProfileDisable_Startup
139 Triggering behaviors of the upgrade dialog. Value indicates which
140 condition failed or all satisfied.
141 This event was generated to correspond to the Legacy Telemetry event
142 upgrade_dialog.trigger#reason.
144 - https://bugzil.la/1697222
146 - https://bugzil.la/1697222
153 The `value` of the event. Mirrors to the Legacy Telemetry
154 event's `value` parameter.
156 telemetry_mirror: Upgrade_dialog_Trigger_Reason
159 abouthome_cache_result:
162 How the about:home startup cache functioned on startup.
164 0: Result value was never set (error case)
165 1: Cache did not exist
166 2: Cache page stream was corrupt / inaccessible
167 3: Cache script stream was corrupt / inaccessible
168 4: Cache was invalidated by a version bump
169 5: Cache was valid, but read too late to be useful.
170 6: Cache was valid and used.
171 7: Cache is disabled.
172 8: User did not load about:home on its own by default.
173 9: Cache is disabled because about:newtab preloading is disabled.
175 This metric was generated to correspond to the Legacy Telemetry
176 scalar browser.startup.abouthome_cache_result.
178 - https://bugzil.la/1622263
179 - https://bugzil.la/1614351
180 - https://bugzil.la/1683101
181 - https://bugzil.la/1714258
182 - https://bugzil.la/1730042
183 - https://bugzil.la/1754641
184 - https://bugzil.la/1781978
185 - https://bugzil.la/1811151
186 - https://bugzil.la/1841926
188 - https://bugzil.la/1622263
189 - https://bugzil.la/1614351
190 - https://bugzil.la/1683101
191 - https://bugzil.la/1714258
192 - https://bugzil.la/1730042
193 - https://bugzil.la/1754641
194 - https://bugzil.la/1781978
195 - https://bugzil.la/1811151
196 - https://bugzil.la/1841926
198 - mconley@mozilla.com
199 - perf-telemetry-alerts@mozilla.com
201 unit: CACHE_RESULT_SCALARS
202 telemetry_mirror: BROWSER_STARTUP_ABOUTHOME_CACHE_RESULT
206 abouthome_cache_shutdownwrite:
209 True if the about:home startup cache was written via the
210 AsyncShutdown blocker.
211 This metric was generated to correspond to the Legacy Telemetry
212 scalar browser.startup.abouthome_cache_shutdownwrite.
214 - https://bugzil.la/1622263
215 - https://bugzil.la/1614351
216 - https://bugzil.la/1683101
217 - https://bugzil.la/1714258
218 - https://bugzil.la/1730042
219 - https://bugzil.la/1754641
220 - https://bugzil.la/1781978
221 - https://bugzil.la/1811151
222 - https://bugzil.la/1841926
224 - https://bugzil.la/1622263
225 - https://bugzil.la/1614351
226 - https://bugzil.la/1683101
227 - https://bugzil.la/1714258
228 - https://bugzil.la/1730042
229 - https://bugzil.la/1754641
230 - https://bugzil.la/1781978
231 - https://bugzil.la/1811151
232 - https://bugzil.la/1841926
234 - mconley@mozilla.com
235 - perf-telemetry-alerts@mozilla.com
237 telemetry_mirror: BROWSER_STARTUP_ABOUTHOME_CACHE_SHUTDOWNWRITE
242 privacy_sanitize_sanitize_on_shutdown:
245 A boolean reporting the value of the
246 privacy.sanitize.sanitizeOnShutdown pref.
247 This metric was generated to correspond to the Legacy Telemetry
248 scalar datasanitization.privacy_sanitize_sanitizeOnShutdown.
250 - https://bugzil.la/1589753
251 - https://bugzil.la/1617241
252 - https://bugzil.la/1645089
253 - https://bugzil.la/1678210
255 - https://bugzil.la/1589753
256 - https://bugzil.la/1617241
257 - https://bugzil.la/1645089
258 - https://bugzil.la/1678210
260 - ewright@mozilla.com
261 - seceng-telemetry@mozilla.com
263 telemetry_mirror: DATASANITIZATION_PRIVACY_SANITIZE_SANITIZEONSHUTDOWN
265 privacy_clear_on_shutdown_cookies:
268 A boolean reporting the value of the privacy.clearOnShutdown.cookies
270 This metric was generated to correspond to the Legacy Telemetry
271 scalar datasanitization.privacy_clearOnShutdown_cookies.
273 - https://bugzil.la/1589753
274 - https://bugzil.la/1617241
275 - https://bugzil.la/1645089
276 - https://bugzil.la/1678210
278 - https://bugzil.la/1589753
279 - https://bugzil.la/1617241
280 - https://bugzil.la/1645089
281 - https://bugzil.la/1678210
283 - ewright@mozilla.com
284 - seceng-telemetry@mozilla.com
286 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_COOKIES
288 privacy_clear_on_shutdown_history:
291 A boolean reporting the value of the privacy.clearOnShutdown.history
293 This metric was generated to correspond to the Legacy Telemetry
294 scalar datasanitization.privacy_clearOnShutdown_history.
296 - https://bugzil.la/1589753
297 - https://bugzil.la/1617241
298 - https://bugzil.la/1645089
299 - https://bugzil.la/1678210
301 - https://bugzil.la/1589753
302 - https://bugzil.la/1617241
303 - https://bugzil.la/1645089
304 - https://bugzil.la/1678210
306 - ewright@mozilla.com
307 - seceng-telemetry@mozilla.com
309 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_HISTORY
311 privacy_clear_on_shutdown_formdata:
314 A boolean reporting the value of the
315 privacy.clearOnShutdown.formdata pref.
316 This metric was generated to correspond to the Legacy Telemetry
317 scalar datasanitization.privacy_clearOnShutdown_formdata.
319 - https://bugzil.la/1589753
320 - https://bugzil.la/1617241
321 - https://bugzil.la/1645089
322 - https://bugzil.la/1678210
324 - https://bugzil.la/1589753
325 - https://bugzil.la/1617241
326 - https://bugzil.la/1645089
327 - https://bugzil.la/1678210
329 - ewright@mozilla.com
330 - seceng-telemetry@mozilla.com
332 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_FORMDATA
334 privacy_clear_on_shutdown_downloads:
337 A boolean reporting the value of the
338 privacy.clearOnShutdown.downloads pref.
339 This metric was generated to correspond to the Legacy Telemetry
340 scalar datasanitization.privacy_clearOnShutdown_downloads.
342 - https://bugzil.la/1589753
343 - https://bugzil.la/1617241
344 - https://bugzil.la/1645089
345 - https://bugzil.la/1678210
347 - https://bugzil.la/1589753
348 - https://bugzil.la/1617241
349 - https://bugzil.la/1645089
350 - https://bugzil.la/1678210
352 - ewright@mozilla.com
353 - seceng-telemetry@mozilla.com
355 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_DOWNLOADS
357 privacy_clear_on_shutdown_cache:
360 A boolean reporting the value of the privacy.clearOnShutdown.cache
362 This metric was generated to correspond to the Legacy Telemetry
363 scalar datasanitization.privacy_clearOnShutdown_cache.
365 - https://bugzil.la/1589753
366 - https://bugzil.la/1617241
367 - https://bugzil.la/1645089
368 - https://bugzil.la/1678210
370 - https://bugzil.la/1589753
371 - https://bugzil.la/1617241
372 - https://bugzil.la/1645089
373 - https://bugzil.la/1678210
375 - ewright@mozilla.com
376 - seceng-telemetry@mozilla.com
378 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_CACHE
380 privacy_clear_on_shutdown_sessions:
383 A boolean reporting the value of the
384 privacy.clearOnShutdown.sessions pref.
385 This metric was generated to correspond to the Legacy Telemetry
386 scalar datasanitization.privacy_clearOnShutdown_sessions.
388 - https://bugzil.la/1589753
389 - https://bugzil.la/1617241
390 - https://bugzil.la/1645089
391 - https://bugzil.la/1678210
393 - https://bugzil.la/1589753
394 - https://bugzil.la/1617241
395 - https://bugzil.la/1645089
396 - https://bugzil.la/1678210
398 - ewright@mozilla.com
399 - seceng-telemetry@mozilla.com
401 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_SESSIONS
403 privacy_clear_on_shutdown_offline_apps:
406 A boolean reporting the value of the
407 privacy.clearOnShutdown.offlineApps pref.
408 This metric was generated to correspond to the Legacy Telemetry
409 scalar datasanitization.privacy_clearOnShutdown_offlineApps.
411 - https://bugzil.la/1589753
412 - https://bugzil.la/1617241
413 - https://bugzil.la/1645089
414 - https://bugzil.la/1678210
416 - https://bugzil.la/1589753
417 - https://bugzil.la/1617241
418 - https://bugzil.la/1645089
419 - https://bugzil.la/1678210
421 - ewright@mozilla.com
422 - seceng-telemetry@mozilla.com
424 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_OFFLINEAPPS
426 privacy_clear_on_shutdown_site_settings:
429 A boolean reporting the value of the
430 privacy.clearOnShutdown.siteSettings pref.
431 This metric was generated to correspond to the Legacy Telemetry
432 scalar datasanitization.privacy_clearOnShutdown_siteSettings.
434 - https://bugzil.la/1589753
435 - https://bugzil.la/1617241
436 - https://bugzil.la/1645089
437 - https://bugzil.la/1678210
439 - https://bugzil.la/1589753
440 - https://bugzil.la/1617241
441 - https://bugzil.la/1645089
442 - https://bugzil.la/1678210
444 - ewright@mozilla.com
445 - seceng-telemetry@mozilla.com
447 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_SITESETTINGS
449 privacy_clear_on_shutdown_open_windows:
452 A boolean reporting the value of the
453 privacy.clearOnShutdown.openWindows pref.
454 This metric was generated to correspond to the Legacy Telemetry
455 scalar datasanitization.privacy_clearOnShutdown_openWindows.
457 - https://bugzil.la/1589753
458 - https://bugzil.la/1617241
459 - https://bugzil.la/1645089
460 - https://bugzil.la/1678210
462 - https://bugzil.la/1589753
463 - https://bugzil.la/1617241
464 - https://bugzil.la/1645089
465 - https://bugzil.la/1678210
467 - ewright@mozilla.com
468 - seceng-telemetry@mozilla.com
470 telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_OPENWINDOWS
472 session_permission_exceptions:
475 A count of how many "session" cookie exceptions a user has set.
476 This metric was generated to correspond to the Legacy Telemetry
477 scalar datasanitization.session_permission_exceptions.
479 - https://bugzil.la/1589753
480 - https://bugzil.la/1617241
481 - https://bugzil.la/1645089
482 - https://bugzil.la/1678210
483 - https://bugzil.la/1744559
485 - https://bugzil.la/1589753
486 - https://bugzil.la/1617241
487 - https://bugzil.la/1645089
488 - https://bugzil.la/1678210
489 - https://bugzil.la/1744559
492 - seceng-telemetry@mozilla.com
495 telemetry_mirror: DATASANITIZATION_SESSION_PERMISSION_EXCEPTIONS
501 Whether or not this startup is the first startup since OS reboot
502 (according to our best guess.)
503 This metric was generated to correspond to the Legacy Telemetry
504 scalar startup.is_cold.
506 - https://bugzil.la/1542833
508 - https://bugzil.la/1542833
510 - dothayer@mozilla.com
512 telemetry_mirror: STARTUP_IS_COLD
514 seconds_since_last_os_restart:
517 The time in seconds between the first browser window loading, and
518 the time the OS started. This can give us an indication of whether
519 starting the browser may have been the first thing the user did
520 after starting their computer.
521 This metric was generated to correspond to the Legacy Telemetry
522 scalar startup.seconds_since_last_os_restart.
524 - https://bugzil.la/1654063
526 - https://bugzil.la/1654063
528 - dothayer@mozilla.com
531 telemetry_mirror: STARTUP_SECONDS_SINCE_LAST_OS_RESTART
537 Records how Firefox was started on Windows. Currently will be one of
538 "Desktop", "DesktopPrivate", "StartMenu" (including pins),
539 "StartMenuPrivate", "Taskbar", "TaskbarPrivate", "OtherShortcut", or
541 This metric was generated to correspond to the Legacy Telemetry
542 scalar os.environment.launch_method.
544 - https://bugzil.la/1685213
545 - https://bugzil.la/1725298
546 - https://bugzil.la/1754656
548 - https://bugzil.la/1685213
549 - https://bugzil.la/1725298
550 - https://bugzil.la/1754656
552 - application-update-telemetry-alerts@mozilla.com
553 - rtestard@mozilla.com
556 telemetry_mirror: OS_ENVIRONMENT_LAUNCH_METHOD
559 type: labeled_counter
561 Records counts for when Firefox was launched afresh (i.e., was not
562 already running) to handle a file type or protocol with `-osint -url
563 ...`. The result is split into keys which represent the file
564 extension: currently, the set of file types Firefox registers to
565 handle, namely ".avif", ".htm", ".html", ".pdf", ".shtml", ".xht",
566 ".xhtml", ".svg", ".webp", and the set of protocol schemes that
567 Firefox registers to handle, namely "about", "http", "https",
568 "mailto". If Firefox was launched to handle a file type or protocol
569 it does not register to handle by default, the count is recorded as
570 ".<other extension>" or "<other protocol>", respectively (neither of
571 which are valid extension or protocol identifiers).
572 This metric was generated to correspond to the Legacy Telemetry
573 scalar os.environment.launched_to_handle.
575 - https://bugzil.la/1243603
576 - https://bugzil.la/1781984
578 - https://bugzil.la/1243603
579 - https://bugzil.la/1781984
581 - application-update-telemetry-alerts@mozilla.com
583 telemetry_mirror: OS_ENVIRONMENT_LAUNCHED_TO_HANDLE
586 type: labeled_counter
588 Records counts for when Firefox was invoked (i.e., was already
589 running and was not launched) to handle a file type or protocol with
590 `-osint -url ...`. The result is split into keys which represent
591 the file extension: currently, the set of file types Firefox
592 registers to handle, namely ".avif", ".htm", ".html", ".pdf",
593 ".shtml", ".xht", ".xhtml", ".svg", ".webp", and the set of protocol
594 schemes that Firefox registers to handle, namely "about", "http",
595 "https", "mailto". If Firefox was invoked to handle a file type or
596 protocol it does not register to handle by default, the count is
597 recorded as ".<other extension>" or "<other protocol>", respectively
598 (neither of which are valid extension or protocol identifiers).
599 This metric was generated to correspond to the Legacy Telemetry
600 scalar os.environment.invoked_to_handle.
602 - https://bugzil.la/1243603
603 - https://bugzil.la/1781984
605 - https://bugzil.la/1243603
606 - https://bugzil.la/1781984
608 - application-update-telemetry-alerts@mozilla.com
610 telemetry_mirror: OS_ENVIRONMENT_INVOKED_TO_HANDLE
613 type: labeled_boolean
615 Records whether Firefox was the default handler for particular file
616 types or protocols. The result is split into keys which represent
617 the file extension or scheme: currently, a subset of the file types
618 Firefox registers to handle, namely ".pdf" and "mailto" as protocol.
619 In the future, more file types may be recorded.
620 This metric was generated to correspond to the Legacy Telemetry
621 scalar os.environment.is_default_handler.
623 - https://bugzil.la/1743914
624 - https://bugzil.la/1781984
625 - https://bugzil.la/1842290
627 - https://bugzil.la/1743914
628 - https://bugzil.la/1781984
629 - https://bugzil.la/1842290
631 - application-update-telemetry-alerts@mozilla.com
633 telemetry_mirror: OS_ENVIRONMENT_IS_DEFAULT_HANDLER
638 Whether this app was kept in macOS Dock on startup
639 This metric was generated to correspond to the Legacy Telemetry
640 scalar os.environment.is_kept_in_dock.
642 - https://bugzil.la/1715348
644 - https://bugzil.la/1715348
649 telemetry_mirror: OS_ENVIRONMENT_IS_KEPT_IN_DOCK
654 Whether the non-Private Browsing version of this app was pinned to
656 This metric was generated to correspond to the Legacy Telemetry
657 scalar os.environment.is_taskbar_pinned.
659 - https://bugzil.la/1685213
660 - https://bugzil.la/1725298
662 - https://bugzil.la/1685213
663 - https://bugzil.la/1725298
665 - application-update-telemetry-alerts@mozilla.com
668 telemetry_mirror: OS_ENVIRONMENT_IS_TASKBAR_PINNED
670 is_taskbar_pinned_private:
673 Whether the Private Browsing version of this app was pinned to
675 This metric was generated to correspond to the Legacy Telemetry
676 scalar os.environment.is_taskbar_pinned_private.
678 - https://bugzil.la/1751038
680 - https://bugzil.la/1751038
682 - application-update-telemetry-alerts@mozilla.com
685 telemetry_mirror: OS_ENVIRONMENT_IS_TASKBAR_PINNED_PRIVATE
688 https_only_mode_enabled:
691 Measures user retention of the HTTPS-Only Mode. 0 = never enabled, 1
692 = enabled, 2 = disabled (but was enabled)
693 This metric was generated to correspond to the Legacy Telemetry
694 scalar security.https_only_mode_enabled.
696 - https://bugzil.la/1620244
698 - https://bugzil.la/1620244
700 - julianwels@mozilla.com
701 - seceng-telemetry@mozilla.com
704 telemetry_mirror: SECURITY_HTTPS_ONLY_MODE_ENABLED
706 https_only_mode_enabled_pbm:
709 Measures user retention of the HTTPS-Only Mode in Private Browsing.
710 0 = https-only never enabled in PBM, 1 = https-only enabled in PBM,
711 2 = https-only disabled in PBM (but was enabled)
712 This metric was generated to correspond to the Legacy Telemetry
713 scalar security.https_only_mode_enabled_pbm.
715 - https://bugzil.la/1647719
717 - https://bugzil.la/1647719
719 - julianwels@mozilla.com
720 - ckerschb@mozilla.com
721 - seceng-telemetry@mozilla.com
724 telemetry_mirror: SECURITY_HTTPS_ONLY_MODE_ENABLED_PBM
726 global_privacy_control_enabled:
729 Measures user retention of the Global Privacy Control. 0 = never
730 enabled, 1 = enabled, 2 = disabled (but was enabled)
731 This metric was generated to correspond to the Legacy Telemetry
732 scalar security.global_privacy_control_enabled.
734 - https://bugzil.la/1734185
736 - https://bugzil.la/1734185
738 - seceng-telemetry@mozilla.com
741 telemetry_mirror: SECURITY_GLOBAL_PRIVACY_CONTROL_ENABLED
747 If a primary-password is enabled for this profile.
748 Set soon after browser startup.
749 Does not update if a primary password is added or removed after startup.
751 - https://bugzil.la/1936036
753 - https://bugzil.la/1936036
755 - mtigley@mozilla.com
757 telemetry_mirror: PRIMARY_PASSWORD_ENABLED