tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

metrics.yaml (35065B)


      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 :: General'
     12 
     13 browser.launched_to_handle:
     14  system_notification:
     15    type: event
     16    description: >
     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.
     19    bugs:
     20      - https://bugzilla.mozilla.org/show_bug.cgi?id=1788960
     21    data_reviews:
     22      - https://bugzilla.mozilla.org/show_bug.cgi?id=1788960#c10
     23    data_sensitivity:
     24      - interaction
     25    notification_emails:
     26      - nalexander@mozilla.com
     27      - rtestard@mozilla.com
     28    expires: never
     29    extra_keys:
     30      name:
     31        description: >
     32          The `name` of the system (chrome privileged) alert that Firefox was
     33          launched to complete.
     34        type: string
     35      action:
     36        description: >
     37          The `action` of the system (chrome privileged) alert that Firefox was
     38          launched to complete.
     39        type: string
     40    telemetry_mirror: BrowserLaunched_to_handle_SystemNotification_Toast
     41 
     42 background_update:
     43  reasons_to_not_update:
     44    type: string_list
     45    description: >
     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`
     49    bugs:
     50      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
     51    data_reviews:
     52      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
     53    data_sensitivity:
     54      - technical
     55    notification_emails:
     56      - install-update@mozilla.com
     57    expires: never
     58    send_in_pings:
     59      - background-update
     60      - metrics
     61    lifetime: application
     62 
     63  time_last_update_scheduled:
     64    type: datetime
     65    time_unit: day
     66    description: >
     67      Last time the background update was triggered.
     68    bugs:
     69      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
     70    data_reviews:
     71      - https://bugzilla.mozilla.org/show_bug.cgi?id=1795471
     72    data_sensitivity:
     73      - interaction
     74    notification_emails:
     75      - install-update@mozilla.com
     76    expires: never
     77    send_in_pings:
     78      - background-update
     79      - metrics
     80    lifetime: application
     81 
     82 start_menu:
     83  manually_unpinned_since_last_launch:
     84    type: event
     85    description: >
     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.
     89    bugs:
     90      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900035
     91    data_reviews:
     92      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900035
     93    data_sensitivity:
     94      - interaction
     95    notification_emails:
     96      - install-update@mozilla.com
     97    expires: never
     98    send_in_pings:
     99      - events
    100    lifetime: ping
    101 
    102 sslkeylogging:
    103  enabled:
    104    type: boolean
    105    description: >
    106      Records whether TLS key logging has been enabled via the environment
    107      variable SSLKEYLOGFILE.
    108    bugs:
    109      - https://bugzilla.mozilla.org/show_bug.cgi?id=1918455
    110    data_reviews:
    111      - https://bugzilla.mozilla.org/show_bug.cgi?id=1918455
    112    data_sensitivity:
    113      - technical
    114    notification_emails:
    115      - dkeeler@mozilla.com
    116    expires: never
    117 
    118 launch_on_login:
    119  last_profile_disable_startup:
    120    type: event
    121    description: >
    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.
    126    bugs:
    127      - https://bugzil.la/1858223
    128    data_reviews:
    129      - https://bugzil.la/1858223
    130    notification_emails:
    131      - nalexander@mozilla.com
    132    expires: never
    133    telemetry_mirror: Launch_on_login_LastProfileDisable_Startup
    134 
    135 upgrade_dialog:
    136  trigger_reason:
    137    type: event
    138    description: >
    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.
    143    bugs:
    144      - https://bugzil.la/1697222
    145    data_reviews:
    146      - https://bugzil.la/1697222
    147    notification_emails:
    148      - edilee@mozilla.com
    149    expires: never
    150    extra_keys:
    151      value:
    152        description: >
    153          The `value` of the event. Mirrors to the Legacy Telemetry
    154          event's `value` parameter.
    155        type: string
    156    telemetry_mirror: Upgrade_dialog_Trigger_Reason
    157 
    158 browser.startup:
    159  abouthome_cache_result:
    160    type: quantity
    161    description: >
    162      How the about:home startup cache functioned on startup.
    163 
    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.
    174 
    175      This metric was generated to correspond to the Legacy Telemetry
    176      scalar browser.startup.abouthome_cache_result.
    177    bugs:
    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
    187    data_reviews:
    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
    197    notification_emails:
    198      - mconley@mozilla.com
    199      - perf-telemetry-alerts@mozilla.com
    200    expires: never
    201    unit: CACHE_RESULT_SCALARS
    202    telemetry_mirror: BROWSER_STARTUP_ABOUTHOME_CACHE_RESULT
    203    no_lint:
    204      - COMMON_PREFIX
    205 
    206  abouthome_cache_shutdownwrite:
    207    type: boolean
    208    description: >
    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.
    213    bugs:
    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
    223    data_reviews:
    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
    233    notification_emails:
    234      - mconley@mozilla.com
    235      - perf-telemetry-alerts@mozilla.com
    236    expires: never
    237    telemetry_mirror: BROWSER_STARTUP_ABOUTHOME_CACHE_SHUTDOWNWRITE
    238    no_lint:
    239      - COMMON_PREFIX
    240  kiosk_mode:
    241    type: boolean
    242    description: >
    243      True when the browser was started in kiosk mode.
    244    bugs:
    245      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914581
    246    data_reviews:
    247      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914581
    248    data_sensitivity:
    249      - technical
    250    notification_emails:
    251      - rtestard@mozilla.com
    252    expires: never
    253    lifetime: application
    254 
    255 datasanitization:
    256  privacy_sanitize_sanitize_on_shutdown:
    257    type: boolean
    258    description: >
    259      A boolean reporting the value of the
    260      privacy.sanitize.sanitizeOnShutdown pref.
    261      This metric was generated to correspond to the Legacy Telemetry
    262      scalar datasanitization.privacy_sanitize_sanitizeOnShutdown.
    263    bugs:
    264      - https://bugzil.la/1589753
    265      - https://bugzil.la/1617241
    266      - https://bugzil.la/1645089
    267      - https://bugzil.la/1678210
    268    data_reviews:
    269      - https://bugzil.la/1589753
    270      - https://bugzil.la/1617241
    271      - https://bugzil.la/1645089
    272      - https://bugzil.la/1678210
    273    notification_emails:
    274      - ewright@mozilla.com
    275      - seceng-telemetry@mozilla.com
    276    expires: never
    277    telemetry_mirror: DATASANITIZATION_PRIVACY_SANITIZE_SANITIZEONSHUTDOWN
    278 
    279  privacy_clear_on_shutdown_cookies:
    280    type: boolean
    281    description: >
    282      A boolean reporting the value of the privacy.clearOnShutdown.cookies
    283      pref.
    284      This metric was generated to correspond to the Legacy Telemetry
    285      scalar datasanitization.privacy_clearOnShutdown_cookies.
    286    bugs:
    287      - https://bugzil.la/1589753
    288      - https://bugzil.la/1617241
    289      - https://bugzil.la/1645089
    290      - https://bugzil.la/1678210
    291    data_reviews:
    292      - https://bugzil.la/1589753
    293      - https://bugzil.la/1617241
    294      - https://bugzil.la/1645089
    295      - https://bugzil.la/1678210
    296    notification_emails:
    297      - ewright@mozilla.com
    298      - seceng-telemetry@mozilla.com
    299    expires: never
    300    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_COOKIES
    301 
    302  privacy_clear_on_shutdown_history:
    303    type: boolean
    304    description: >
    305      A boolean reporting the value of the privacy.clearOnShutdown.history
    306      pref.
    307      This metric was generated to correspond to the Legacy Telemetry
    308      scalar datasanitization.privacy_clearOnShutdown_history.
    309    bugs:
    310      - https://bugzil.la/1589753
    311      - https://bugzil.la/1617241
    312      - https://bugzil.la/1645089
    313      - https://bugzil.la/1678210
    314    data_reviews:
    315      - https://bugzil.la/1589753
    316      - https://bugzil.la/1617241
    317      - https://bugzil.la/1645089
    318      - https://bugzil.la/1678210
    319    notification_emails:
    320      - ewright@mozilla.com
    321      - seceng-telemetry@mozilla.com
    322    expires: never
    323    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_HISTORY
    324 
    325  privacy_clear_on_shutdown_formdata:
    326    type: boolean
    327    description: >
    328      A boolean reporting the value of the
    329      privacy.clearOnShutdown.formdata pref.
    330      This metric was generated to correspond to the Legacy Telemetry
    331      scalar datasanitization.privacy_clearOnShutdown_formdata.
    332    bugs:
    333      - https://bugzil.la/1589753
    334      - https://bugzil.la/1617241
    335      - https://bugzil.la/1645089
    336      - https://bugzil.la/1678210
    337    data_reviews:
    338      - https://bugzil.la/1589753
    339      - https://bugzil.la/1617241
    340      - https://bugzil.la/1645089
    341      - https://bugzil.la/1678210
    342    notification_emails:
    343      - ewright@mozilla.com
    344      - seceng-telemetry@mozilla.com
    345    expires: never
    346    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_FORMDATA
    347 
    348  privacy_clear_on_shutdown_downloads:
    349    type: boolean
    350    description: >
    351      A boolean reporting the value of the
    352      privacy.clearOnShutdown.downloads pref.
    353      This metric was generated to correspond to the Legacy Telemetry
    354      scalar datasanitization.privacy_clearOnShutdown_downloads.
    355    bugs:
    356      - https://bugzil.la/1589753
    357      - https://bugzil.la/1617241
    358      - https://bugzil.la/1645089
    359      - https://bugzil.la/1678210
    360    data_reviews:
    361      - https://bugzil.la/1589753
    362      - https://bugzil.la/1617241
    363      - https://bugzil.la/1645089
    364      - https://bugzil.la/1678210
    365    notification_emails:
    366      - ewright@mozilla.com
    367      - seceng-telemetry@mozilla.com
    368    expires: never
    369    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_DOWNLOADS
    370 
    371  privacy_clear_on_shutdown_cache:
    372    type: boolean
    373    description: >
    374      A boolean reporting the value of the privacy.clearOnShutdown.cache
    375      pref.
    376      This metric was generated to correspond to the Legacy Telemetry
    377      scalar datasanitization.privacy_clearOnShutdown_cache.
    378    bugs:
    379      - https://bugzil.la/1589753
    380      - https://bugzil.la/1617241
    381      - https://bugzil.la/1645089
    382      - https://bugzil.la/1678210
    383    data_reviews:
    384      - https://bugzil.la/1589753
    385      - https://bugzil.la/1617241
    386      - https://bugzil.la/1645089
    387      - https://bugzil.la/1678210
    388    notification_emails:
    389      - ewright@mozilla.com
    390      - seceng-telemetry@mozilla.com
    391    expires: never
    392    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_CACHE
    393 
    394  privacy_clear_on_shutdown_sessions:
    395    type: boolean
    396    description: >
    397      A boolean reporting the value of the
    398      privacy.clearOnShutdown.sessions pref.
    399      This metric was generated to correspond to the Legacy Telemetry
    400      scalar datasanitization.privacy_clearOnShutdown_sessions.
    401    bugs:
    402      - https://bugzil.la/1589753
    403      - https://bugzil.la/1617241
    404      - https://bugzil.la/1645089
    405      - https://bugzil.la/1678210
    406    data_reviews:
    407      - https://bugzil.la/1589753
    408      - https://bugzil.la/1617241
    409      - https://bugzil.la/1645089
    410      - https://bugzil.la/1678210
    411    notification_emails:
    412      - ewright@mozilla.com
    413      - seceng-telemetry@mozilla.com
    414    expires: never
    415    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_SESSIONS
    416 
    417  privacy_clear_on_shutdown_offline_apps:
    418    type: boolean
    419    description: >
    420      A boolean reporting the value of the
    421      privacy.clearOnShutdown.offlineApps pref.
    422      This metric was generated to correspond to the Legacy Telemetry
    423      scalar datasanitization.privacy_clearOnShutdown_offlineApps.
    424    bugs:
    425      - https://bugzil.la/1589753
    426      - https://bugzil.la/1617241
    427      - https://bugzil.la/1645089
    428      - https://bugzil.la/1678210
    429    data_reviews:
    430      - https://bugzil.la/1589753
    431      - https://bugzil.la/1617241
    432      - https://bugzil.la/1645089
    433      - https://bugzil.la/1678210
    434    notification_emails:
    435      - ewright@mozilla.com
    436      - seceng-telemetry@mozilla.com
    437    expires: never
    438    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_OFFLINEAPPS
    439 
    440  privacy_clear_on_shutdown_site_settings:
    441    type: boolean
    442    description: >
    443      A boolean reporting the value of the
    444      privacy.clearOnShutdown.siteSettings pref.
    445      This metric was generated to correspond to the Legacy Telemetry
    446      scalar datasanitization.privacy_clearOnShutdown_siteSettings.
    447    bugs:
    448      - https://bugzil.la/1589753
    449      - https://bugzil.la/1617241
    450      - https://bugzil.la/1645089
    451      - https://bugzil.la/1678210
    452    data_reviews:
    453      - https://bugzil.la/1589753
    454      - https://bugzil.la/1617241
    455      - https://bugzil.la/1645089
    456      - https://bugzil.la/1678210
    457    notification_emails:
    458      - ewright@mozilla.com
    459      - seceng-telemetry@mozilla.com
    460    expires: never
    461    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_SITESETTINGS
    462 
    463  privacy_clear_on_shutdown_open_windows:
    464    type: boolean
    465    description: >
    466      A boolean reporting the value of the
    467      privacy.clearOnShutdown.openWindows pref.
    468      This metric was generated to correspond to the Legacy Telemetry
    469      scalar datasanitization.privacy_clearOnShutdown_openWindows.
    470    bugs:
    471      - https://bugzil.la/1589753
    472      - https://bugzil.la/1617241
    473      - https://bugzil.la/1645089
    474      - https://bugzil.la/1678210
    475    data_reviews:
    476      - https://bugzil.la/1589753
    477      - https://bugzil.la/1617241
    478      - https://bugzil.la/1645089
    479      - https://bugzil.la/1678210
    480    notification_emails:
    481      - ewright@mozilla.com
    482      - seceng-telemetry@mozilla.com
    483    expires: never
    484    telemetry_mirror: DATASANITIZATION_PRIVACY_CLEARONSHUTDOWN_OPENWINDOWS
    485 
    486  session_permission_exceptions:
    487    type: quantity
    488    description: >
    489      A count of how many "session" cookie exceptions a user has set.
    490      This metric was generated to correspond to the Legacy Telemetry
    491      scalar datasanitization.session_permission_exceptions.
    492    bugs:
    493      - https://bugzil.la/1589753
    494      - https://bugzil.la/1617241
    495      - https://bugzil.la/1645089
    496      - https://bugzil.la/1678210
    497      - https://bugzil.la/1744559
    498    data_reviews:
    499      - https://bugzil.la/1589753
    500      - https://bugzil.la/1617241
    501      - https://bugzil.la/1645089
    502      - https://bugzil.la/1678210
    503      - https://bugzil.la/1744559
    504    notification_emails:
    505      - emz@mozilla.com
    506      - seceng-telemetry@mozilla.com
    507    expires: never
    508    unit: unknown
    509    telemetry_mirror: DATASANITIZATION_SESSION_PERMISSION_EXCEPTIONS
    510 
    511 startup:
    512  is_cold:
    513    type: boolean
    514    description: >
    515      Whether or not this startup is the first startup since OS reboot
    516      (according to our best guess.)
    517      This metric was generated to correspond to the Legacy Telemetry
    518      scalar startup.is_cold.
    519    bugs:
    520      - https://bugzil.la/1542833
    521    data_reviews:
    522      - https://bugzil.la/1542833
    523    notification_emails:
    524      - dothayer@mozilla.com
    525    expires: never
    526    telemetry_mirror: STARTUP_IS_COLD
    527 
    528  seconds_since_last_os_restart:
    529    type: quantity
    530    description: >
    531      The time in seconds between the first browser window loading, and
    532      the time the OS started. This can give us an indication of whether
    533      starting the browser may have been the first thing the user did
    534      after starting their computer.
    535      This metric was generated to correspond to the Legacy Telemetry
    536      scalar startup.seconds_since_last_os_restart.
    537    bugs:
    538      - https://bugzil.la/1654063
    539    data_reviews:
    540      - https://bugzil.la/1654063
    541    notification_emails:
    542      - dothayer@mozilla.com
    543    expires: never
    544    unit: seconds
    545    telemetry_mirror: STARTUP_SECONDS_SINCE_LAST_OS_RESTART
    546 
    547 os.environment:
    548  launch_method:
    549    type: string
    550    description: >
    551      Records how Firefox was started on Windows. Currently will be one of
    552      "Desktop", "DesktopPrivate", "StartMenu" (including pins),
    553      "StartMenuPrivate", "Taskbar", "TaskbarPrivate", "OtherShortcut", or
    554      "Other"
    555      This metric was generated to correspond to the Legacy Telemetry
    556      scalar os.environment.launch_method.
    557    bugs:
    558      - https://bugzil.la/1685213
    559      - https://bugzil.la/1725298
    560      - https://bugzil.la/1754656
    561    data_reviews:
    562      - https://bugzil.la/1685213
    563      - https://bugzil.la/1725298
    564      - https://bugzil.la/1754656
    565    notification_emails:
    566      - application-update-telemetry-alerts@mozilla.com
    567      - rtestard@mozilla.com
    568      - shong@mozilla.com
    569    expires: never
    570    telemetry_mirror: OS_ENVIRONMENT_LAUNCH_METHOD
    571 
    572  launched_to_handle:
    573    type: labeled_counter
    574    description: >
    575      Records counts for when Firefox was launched afresh (i.e., was not
    576      already running) to handle a file type or protocol with `-osint -url
    577      ...`.  The result is split into keys which represent the file
    578      extension: currently, the set of file types Firefox registers to
    579      handle, namely ".avif", ".htm", ".html", ".pdf", ".shtml", ".xht",
    580      ".xhtml", ".svg", ".webp", and the set of protocol schemes that
    581      Firefox registers to handle, namely "about", "http", "https",
    582      "mailto".  If Firefox was launched to handle a file type or protocol
    583      it does not register to handle by default, the count is recorded as
    584      ".<other extension>" or "<other protocol>", respectively (neither of
    585      which are valid extension or protocol identifiers).
    586      This metric was generated to correspond to the Legacy Telemetry
    587      scalar os.environment.launched_to_handle.
    588    bugs:
    589      - https://bugzil.la/1243603
    590      - https://bugzil.la/1781984
    591    data_reviews:
    592      - https://bugzil.la/1243603
    593      - https://bugzil.la/1781984
    594    notification_emails:
    595      - application-update-telemetry-alerts@mozilla.com
    596    expires: never
    597    telemetry_mirror: OS_ENVIRONMENT_LAUNCHED_TO_HANDLE
    598 
    599  invoked_to_handle:
    600    type: labeled_counter
    601    description: >
    602      Records counts for when Firefox was invoked (i.e., was already
    603      running and was not launched) to handle a file type or protocol with
    604      `-osint -url ...`.  The result is split into keys which represent
    605      the file extension: currently, the set of file types Firefox
    606      registers to handle, namely ".avif", ".htm", ".html", ".pdf",
    607      ".shtml", ".xht", ".xhtml", ".svg", ".webp", and the set of protocol
    608      schemes that Firefox registers to handle, namely "about", "http",
    609      "https", "mailto".  If Firefox was invoked to handle a file type or
    610      protocol it does not register to handle by default, the count is
    611      recorded as ".<other extension>" or "<other protocol>", respectively
    612      (neither of which are valid extension or protocol identifiers).
    613      This metric was generated to correspond to the Legacy Telemetry
    614      scalar os.environment.invoked_to_handle.
    615    bugs:
    616      - https://bugzil.la/1243603
    617      - https://bugzil.la/1781984
    618    data_reviews:
    619      - https://bugzil.la/1243603
    620      - https://bugzil.la/1781984
    621    notification_emails:
    622      - application-update-telemetry-alerts@mozilla.com
    623    expires: never
    624    telemetry_mirror: OS_ENVIRONMENT_INVOKED_TO_HANDLE
    625 
    626  is_default_handler:
    627    type: labeled_boolean
    628    description: >
    629      Records whether Firefox was the default handler for particular file
    630      types or protocols.  The result is split into keys which represent
    631      the file extension or scheme: currently, a subset of the file types
    632      Firefox registers to handle, namely ".pdf" and "mailto" as protocol.
    633      In the future, more file types may be recorded.
    634      This metric was generated to correspond to the Legacy Telemetry
    635      scalar os.environment.is_default_handler.
    636    bugs:
    637      - https://bugzil.la/1743914
    638      - https://bugzil.la/1781984
    639      - https://bugzil.la/1842290
    640    data_reviews:
    641      - https://bugzil.la/1743914
    642      - https://bugzil.la/1781984
    643      - https://bugzil.la/1842290
    644    notification_emails:
    645      - application-update-telemetry-alerts@mozilla.com
    646    expires: never
    647    telemetry_mirror: OS_ENVIRONMENT_IS_DEFAULT_HANDLER
    648 
    649  is_kept_in_dock:
    650    type: boolean
    651    description: >
    652      Whether this app was kept in macOS Dock on startup
    653      This metric was generated to correspond to the Legacy Telemetry
    654      scalar os.environment.is_kept_in_dock.
    655    bugs:
    656      - https://bugzil.la/1715348
    657    data_reviews:
    658      - https://bugzil.la/1715348
    659    notification_emails:
    660      - elee@mozilla.com
    661      - shong@mozilla.com
    662    expires: never
    663    telemetry_mirror: OS_ENVIRONMENT_IS_KEPT_IN_DOCK
    664 
    665  is_taskbar_pinned:
    666    type: boolean
    667    description: >
    668      Whether the non-Private Browsing version of this app was pinned to
    669      taskbar on startup
    670      This metric was generated to correspond to the Legacy Telemetry
    671      scalar os.environment.is_taskbar_pinned.
    672    bugs:
    673      - https://bugzil.la/1685213
    674      - https://bugzil.la/1725298
    675    data_reviews:
    676      - https://bugzil.la/1685213
    677      - https://bugzil.la/1725298
    678    notification_emails:
    679      - application-update-telemetry-alerts@mozilla.com
    680      - shong@mozilla.com
    681    expires: never
    682    telemetry_mirror: OS_ENVIRONMENT_IS_TASKBAR_PINNED
    683 
    684  is_taskbar_pinned_private:
    685    type: boolean
    686    description: >
    687      Whether the Private Browsing version of this app was pinned to
    688      taskbar on startup
    689      This metric was generated to correspond to the Legacy Telemetry
    690      scalar os.environment.is_taskbar_pinned_private.
    691    bugs:
    692      - https://bugzil.la/1751038
    693    data_reviews:
    694      - https://bugzil.la/1751038
    695    notification_emails:
    696      - application-update-telemetry-alerts@mozilla.com
    697      - shong@mozilla.com
    698    expires: never
    699    telemetry_mirror: OS_ENVIRONMENT_IS_TASKBAR_PINNED_PRIVATE
    700 
    701 security:
    702  https_only_mode_enabled:
    703    type: quantity
    704    description: >
    705      Measures user retention of the HTTPS-Only Mode. 0 = never enabled, 1
    706      = enabled, 2 = disabled (but was enabled)
    707      This metric was generated to correspond to the Legacy Telemetry
    708      scalar security.https_only_mode_enabled.
    709    bugs:
    710      - https://bugzil.la/1620244
    711    data_reviews:
    712      - https://bugzil.la/1620244
    713    notification_emails:
    714      - julianwels@mozilla.com
    715      - seceng-telemetry@mozilla.com
    716    expires: never
    717    unit: unknown
    718    telemetry_mirror: SECURITY_HTTPS_ONLY_MODE_ENABLED
    719 
    720  https_only_mode_enabled_pbm:
    721    type: quantity
    722    description: >
    723      Measures user retention of the HTTPS-Only Mode in Private Browsing.
    724      0 = https-only never enabled in PBM, 1 = https-only enabled in PBM,
    725      2 = https-only disabled in PBM (but was enabled)
    726      This metric was generated to correspond to the Legacy Telemetry
    727      scalar security.https_only_mode_enabled_pbm.
    728    bugs:
    729      - https://bugzil.la/1647719
    730    data_reviews:
    731      - https://bugzil.la/1647719
    732    notification_emails:
    733      - julianwels@mozilla.com
    734      - ckerschb@mozilla.com
    735      - seceng-telemetry@mozilla.com
    736    expires: never
    737    unit: unknown
    738    telemetry_mirror: SECURITY_HTTPS_ONLY_MODE_ENABLED_PBM
    739 
    740  global_privacy_control_enabled:
    741    type: quantity
    742    description: >
    743      Measures user retention of the Global Privacy Control. 0 = never
    744      enabled, 1 = enabled, 2 = disabled (but was enabled)
    745      This metric was generated to correspond to the Legacy Telemetry
    746      scalar security.global_privacy_control_enabled.
    747    bugs:
    748      - https://bugzil.la/1734185
    749    data_reviews:
    750      - https://bugzil.la/1734185
    751    notification_emails:
    752      - seceng-telemetry@mozilla.com
    753    expires: never
    754    unit: unknown
    755    telemetry_mirror: SECURITY_GLOBAL_PRIVACY_CONTROL_ENABLED
    756 
    757 primary.password:
    758  enabled:
    759    type: boolean
    760    description: >
    761      If a primary-password is enabled for this profile.
    762      Set soon after browser startup.
    763      Does not update if a primary password is added or removed after startup.
    764    bugs:
    765      - https://bugzil.la/1936036
    766    data_reviews:
    767      - https://bugzil.la/1936036
    768    notification_emails:
    769      - mtigley@mozilla.com
    770    expires: never
    771    telemetry_mirror: PRIMARY_PASSWORD_ENABLED
    772 
    773 browser:
    774  is_user_default:
    775    type: labeled_counter
    776    description: >
    777      Whether Firefox is the system default browser on startup. A true value is
    778      also recorded here, and a false value is recorded to
    779      set_default_error, if a user clicked 'Use Firefox as my default
    780      browser' on an in-product prompt. (Note that on Windows 8+ the latter
    781      action opens the right settings dialog but does not actually change the
    782      default browser without further user action.) On Windows, 'system default
    783      browser' is operationalized as whether Firefox is the default HTTP
    784      protocol handler.
    785 
    786      This metric was generated to correspond to the Legacy Telemetry boolean
    787      histogram BROWSER_IS_USER_DEFAULT.
    788    labels:
    789      - "false"
    790      - "true"
    791    bugs:
    792      - https://bugzilla.mozilla.org/show_bug.cgi?id=855928
    793      - https://bugzilla.mozilla.org/show_bug.cgi?id=1641713
    794    data_reviews:
    795      - https://bugzilla.mozilla.org/show_bug.cgi?id=855928
    796      - https://bugzilla.mozilla.org/show_bug.cgi?id=1641713
    797    notification_emails:
    798      - application-update-telemetry-alerts@mozilla.com
    799    expires: never
    800    telemetry_mirror: h#BROWSER_IS_USER_DEFAULT
    801 
    802  is_user_default_error:
    803    type: labeled_counter
    804    description: >
    805      True if the browser was unable to determine if the browser was set as
    806      default.
    807 
    808      This metric was generated to correspond to the Legacy Telemetry boolean
    809      histogram BROWSER_IS_USER_DEFAULT_ERROR.
    810    labels:
    811      - "false"
    812      - "true"
    813    bugs:
    814      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    815    data_reviews:
    816      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    817    notification_emails:
    818      - application-update-telemetry-alerts@mozilla.com
    819    expires: never
    820    telemetry_mirror: h#BROWSER_IS_USER_DEFAULT_ERROR
    821 
    822  set_default_dialog_prompt_rawcount:
    823    type: custom_distribution
    824    description: >
    825      The number of times that a profile has seen the 'Set Default Browser'
    826      dialog.
    827 
    828      This metric was generated to correspond to the Legacy Telemetry
    829      exponential histogram BROWSER_SET_DEFAULT_DIALOG_PROMPT_RAWCOUNT.
    830    range_min: 1
    831    range_max: 250
    832    bucket_count: 15
    833    histogram_type: exponential
    834    unit: prompts
    835    bugs:
    836      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    837    data_reviews:
    838      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    839    notification_emails:
    840      - application-update-telemetry-alerts@mozilla.com
    841    expires: never
    842    telemetry_mirror: BROWSER_SET_DEFAULT_DIALOG_PROMPT_RAWCOUNT
    843 
    844  set_default_always_check:
    845    type: labeled_counter
    846    description: >
    847      True if the profile has `browser.shell.checkDefaultBrowser` set to true.
    848 
    849      This metric was generated to correspond to the Legacy Telemetry boolean
    850      histogram BROWSER_SET_DEFAULT_ALWAYS_CHECK.
    851    labels:
    852      - "false"
    853      - "true"
    854    bugs:
    855      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    856    data_reviews:
    857      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    858    notification_emails:
    859      - application-update-telemetry-alerts@mozilla.com
    860    expires: never
    861    telemetry_mirror: h#BROWSER_SET_DEFAULT_ALWAYS_CHECK
    862 
    863  set_default_result:
    864    type: custom_distribution
    865    description: >
    866      Result of the Set Default Browser dialog. After Firefox 89 the these
    867      values are: (0=Use Firefox + 'Don't ask again' checked, 1=Use Firefox +
    868      'Don't ask again' unchecked, 2=Not Now + 'Don't ask again' checked, 3=Not
    869      Now + 'Don't ask again' unchecked). Before Firefox 89 these values were:
    870      (0=Use Firefox + 'Always perform check' unchecked, 1=Use Firefox + 'Always
    871      perform check' checked, 2=Not Now + 'Always perform check' unchecked,
    872      3=Not Now + 'Always perform check' checked).
    873 
    874      This metric was generated to correspond to the Legacy Telemetry enumerated
    875      histogram BROWSER_SET_DEFAULT_RESULT.
    876    range_min: 0
    877    range_max: 4
    878    bucket_count: 5
    879    histogram_type: linear
    880    bugs:
    881      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    882    data_reviews:
    883      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    884    notification_emails:
    885      - application-update-telemetry-alerts@mozilla.com
    886    expires: never
    887    telemetry_mirror: BROWSER_SET_DEFAULT_RESULT
    888 
    889  set_default_error:
    890    type: labeled_counter
    891    description: >
    892      True if the browser was unable to set Firefox as the default browser
    893 
    894      This metric was generated to correspond to the Legacy Telemetry boolean
    895      histogram BROWSER_SET_DEFAULT_ERROR.
    896    labels:
    897      - "false"
    898      - "true"
    899    bugs:
    900      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    901    data_reviews:
    902      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    903    notification_emails:
    904      - application-update-telemetry-alerts@mozilla.com
    905    expires: never
    906    telemetry_mirror: h#BROWSER_SET_DEFAULT_ERROR
    907 
    908  set_default_pdf_handler_user_choice_result:
    909    type: labeled_counter
    910    description: >
    911      Result of each attempt to set the default browser with
    912      SetDefaultExtensionHandlersUserChoice() for pdf extension
    913 
    914      This metric was generated to correspond to the Legacy Telemetry
    915      categorical histogram BROWSER_SET_DEFAULT_PDF_HANDLER_USER_CHOICE_RESULT.
    916    labels:
    917      - Success
    918      - ErrProgID
    919      - ErrHash
    920      - ErrLaunchExe
    921      - ErrExeTimeout
    922      - ErrExeProgID
    923      - ErrExeHash
    924      - ErrExeRejected
    925      - ErrExeOther
    926      - ErrOther
    927      - ErrBuild
    928    bugs:
    929      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805509
    930      - https://bugzilla.mozilla.org/show_bug.cgi?id=1883466
    931    data_reviews:
    932      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805509
    933      - https://bugzilla.mozilla.org/show_bug.cgi?id=1883466
    934    notification_emails:
    935      - application-update-telemetry-alerts@mozilla.com
    936    expires: never
    937    telemetry_mirror: h#BROWSER_SET_DEFAULT_PDF_HANDLER_USER_CHOICE_RESULT
    938 
    939  set_default_user_choice_result:
    940    type: labeled_counter
    941    description: >
    942      Result of each attempt to set the default browser with
    943      SetDefaultBrowserUserChoice()
    944 
    945      This metric was generated to correspond to the Legacy Telemetry
    946      categorical histogram BROWSER_SET_DEFAULT_USER_CHOICE_RESULT.
    947    labels:
    948      - Success
    949      - ErrProgID
    950      - ErrHash
    951      - ErrLaunchExe
    952      - ErrExeTimeout
    953      - ErrExeProgID
    954      - ErrExeHash
    955      - ErrExeRejected
    956      - ErrExeOther
    957      - ErrOther
    958      - ErrBuild
    959    bugs:
    960      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703578
    961      - https://bugzilla.mozilla.org/show_bug.cgi?id=1736631
    962      - https://bugzilla.mozilla.org/show_bug.cgi?id=1791928
    963      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881397
    964    data_reviews:
    965      - https://bugzilla.mozilla.org/show_bug.cgi?id=1703578
    966      - https://bugzilla.mozilla.org/show_bug.cgi?id=1736631
    967      - https://bugzilla.mozilla.org/show_bug.cgi?id=1791928
    968      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881397
    969    notification_emails:
    970      - application-update-telemetry-alerts@mozilla.com
    971    expires: never
    972    telemetry_mirror: h#BROWSER_SET_DEFAULT_USER_CHOICE_RESULT
    973 
    974  attribution_errors:
    975    type: labeled_counter
    976    description: >
    977      Count for the number of errors encountered trying to determine attribution
    978      data: on Windows, from the installers (stub and full); on macOS, from an
    979      extended attributed on the .app bundle.
    980 
    981      This metric was generated to correspond to the Legacy Telemetry
    982      categorical histogram BROWSER_ATTRIBUTION_ERRORS.
    983    labels:
    984      - read_error
    985      - decode_error
    986      - write_error
    987      - quarantine_error
    988      - empty_error
    989      - null_error
    990    bugs:
    991      - https://bugzilla.mozilla.org/show_bug.cgi?id=1621402
    992      - https://bugzilla.mozilla.org/show_bug.cgi?id=1525076
    993      - https://bugzilla.mozilla.org/show_bug.cgi?id=1874944
    994    data_reviews:
    995      - https://bugzilla.mozilla.org/show_bug.cgi?id=1621402
    996      - https://bugzilla.mozilla.org/show_bug.cgi?id=1525076
    997      - https://bugzilla.mozilla.org/show_bug.cgi?id=1874944
    998    notification_emails:
    999      - omc-core@mozilla.com
   1000    expires: never
   1001    telemetry_mirror: h#BROWSER_ATTRIBUTION_ERRORS
   1002 
   1003  default_at_launch:
   1004    type: boolean
   1005    lifetime: application
   1006    description: |
   1007      Whether the shell service identified this app as the default browser.
   1008      Checked once near startup.
   1009      On Windows, this is operationalized as whether Firefox is the default
   1010      HTTP protocol handler and the default HTML file handler.
   1011    bugs:
   1012      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
   1013    data_reviews:
   1014      - https://bugzilla.mozilla.org/show_bug.cgi?id=1950389
   1015    notification_emails:
   1016      - application-update-telemetry-alerts@mozilla.com
   1017    data_sensitivity:
   1018      - technical
   1019    expires: never