metrics.yaml (20012B)
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 security.ui.protectionspopup: 14 open_protections_popup: 15 type: event 16 description: > 17 How many times the protections panel was opened. 18 extra_keys: 19 openingReason: 20 description: > 21 string representing how the protections panel was opened, 22 one of ["shieldButtonClicked", "embedPlaceholderButton", "toastButtonClicked"] 23 type: string 24 smartblockEmbedTogglesShown: 25 description: > 26 boolean representing if smartblock toggles were shown to the user 27 type: boolean 28 bugs: &security_ui_protectionspopup_open_bugs 29 - https://bugzil.la/1560327 30 - https://bugzil.la/1607488 31 - https://bugzil.la/1643428 32 - https://bugzil.la/1678201 33 - https://bugzil.la/1739287 34 - https://bugzil.la/1787249 35 - https://bugzil.la/1920735 36 data_reviews: &security_ui_protectionspopup_open_data_reviews 37 - https://bugzil.la/1560327 38 - https://bugzil.la/1607488 39 - https://bugzil.la/1643428 40 - https://bugzil.la/1678201 41 - https://bugzil.la/1739287 42 - https://bugzil.la/1787249 43 - https://bugzil.la/1920735 44 notification_emails: &security_ui_protectionspopup_open_emails 45 - emz@mozilla.com 46 - seceng-telemetry@mozilla.com 47 expires: never 48 49 close_protections_popup: 50 type: event 51 description: > 52 Triggered when the protections panel is closed. Records how the panel was opened and if 53 the SmartBlock section had any interactions 54 extra_keys: 55 openingReason: 56 description: > 57 string representing how the protections panel was opened, 58 one of ["shieldButtonClicked", "embedPlaceholderButton", "toastButtonClicked"] 59 type: string 60 smartblockToggleClicked: 61 description: > 62 boolean representing if the user interacted with the toggle anytime before it was closed 63 type: boolean 64 bugs: 65 - https://bugzil.la/1920735 66 - https://bugzil.la/1958162 67 - https://bugzil.la/1989192 68 data_reviews: 69 - https://bugzil.la/1920735 70 notification_emails: 71 - wwen@mozilla.com 72 - emz@mozilla.com 73 expires: 152 74 75 open_protectionspopup_cfr: 76 type: event 77 description: > 78 How many times the protections panel was opened. 79 bugs: *security_ui_protectionspopup_open_bugs 80 data_reviews: *security_ui_protectionspopup_open_data_reviews 81 notification_emails: *security_ui_protectionspopup_open_emails 82 expires: never 83 extra_keys: &security_ui_protectionspopup_open_extra 84 value: 85 description: > 86 The `value` of the event. Mirrors to the Legacy Telemetry 87 event's `value` parameter. 88 type: string 89 message: 90 description: > 91 For protectionspopup_cfr, the message ID. 92 93 type: string 94 95 click_etp_toggle_on: 96 type: event 97 description: > 98 User interaction by click events in the protections panel. 99 This event was generated to correspond to the Legacy Telemetry event 100 security.ui.protectionspopup.click#etp_toggle_on. 101 bugs: &security_ui_protectionspopup_click_bugs 102 - https://bugzil.la/1560327 103 - https://bugzil.la/1602015 104 - https://bugzil.la/1607488 105 - https://bugzil.la/1643428 106 - https://bugzil.la/1678201 107 - https://bugzil.la/1739287 108 - https://bugzil.la/1787249 109 - https://bugzil.la/1798669 110 data_reviews: &security_ui_protectionspopup_click_data_reviews 111 - https://bugzil.la/1560327 112 - https://bugzil.la/1602015 113 - https://bugzil.la/1607488 114 - https://bugzil.la/1643428 115 - https://bugzil.la/1678201 116 - https://bugzil.la/1739287 117 - https://bugzil.la/1787249 118 - https://bugzil.la/1798669 119 notification_emails: &security_ui_protectionspopup_click_emails 120 - emz@mozilla.com 121 - tihuang@mozilla.com 122 - seceng-telemetry@mozilla.com 123 expires: never 124 telemetry_mirror: SecurityUiProtectionspopup_Click_EtpToggleOn 125 126 click_etp_toggle_off: 127 type: event 128 description: > 129 User interaction by click events in the protections panel. 130 This event was generated to correspond to the Legacy Telemetry event 131 security.ui.protectionspopup.click#etp_toggle_off. 132 bugs: *security_ui_protectionspopup_click_bugs 133 data_reviews: *security_ui_protectionspopup_click_data_reviews 134 notification_emails: *security_ui_protectionspopup_click_emails 135 expires: never 136 telemetry_mirror: SecurityUiProtectionspopup_Click_EtpToggleOff 137 138 click_social: 139 type: event 140 description: > 141 User interaction by click events in the protections panel. 142 This event was generated to correspond to the Legacy Telemetry event 143 security.ui.protectionspopup.click#social. 144 bugs: *security_ui_protectionspopup_click_bugs 145 data_reviews: *security_ui_protectionspopup_click_data_reviews 146 notification_emails: *security_ui_protectionspopup_click_emails 147 expires: never 148 telemetry_mirror: SecurityUiProtectionspopup_Click_Social 149 150 click_cookies: 151 type: event 152 description: > 153 User interaction by click events in the protections panel. 154 This event was generated to correspond to the Legacy Telemetry event 155 security.ui.protectionspopup.click#cookies. 156 bugs: *security_ui_protectionspopup_click_bugs 157 data_reviews: *security_ui_protectionspopup_click_data_reviews 158 notification_emails: *security_ui_protectionspopup_click_emails 159 expires: never 160 telemetry_mirror: SecurityUiProtectionspopup_Click_Cookies 161 162 click_trackers: 163 type: event 164 description: > 165 User interaction by click events in the protections panel. 166 This event was generated to correspond to the Legacy Telemetry event 167 security.ui.protectionspopup.click#trackers. 168 bugs: *security_ui_protectionspopup_click_bugs 169 data_reviews: *security_ui_protectionspopup_click_data_reviews 170 notification_emails: *security_ui_protectionspopup_click_emails 171 expires: never 172 telemetry_mirror: SecurityUiProtectionspopup_Click_Trackers 173 174 click_fingerprinters: 175 type: event 176 description: > 177 User interaction by click events in the protections panel. 178 This event was generated to correspond to the Legacy Telemetry event 179 security.ui.protectionspopup.click#fingerprinters. 180 bugs: *security_ui_protectionspopup_click_bugs 181 data_reviews: *security_ui_protectionspopup_click_data_reviews 182 notification_emails: *security_ui_protectionspopup_click_emails 183 expires: never 184 telemetry_mirror: SecurityUiProtectionspopup_Click_Fingerprinters 185 186 click_cryptominers: 187 type: event 188 description: > 189 User interaction by click events in the protections panel. 190 This event was generated to correspond to the Legacy Telemetry event 191 security.ui.protectionspopup.click#cryptominers. 192 bugs: *security_ui_protectionspopup_click_bugs 193 data_reviews: *security_ui_protectionspopup_click_data_reviews 194 notification_emails: *security_ui_protectionspopup_click_emails 195 expires: never 196 telemetry_mirror: SecurityUiProtectionspopup_Click_Cryptominers 197 198 click_subview_settings: 199 type: event 200 description: > 201 User interaction by click events in the protections panel. 202 This event was generated to correspond to the Legacy Telemetry event 203 security.ui.protectionspopup.click#subview_settings. 204 bugs: *security_ui_protectionspopup_click_bugs 205 data_reviews: *security_ui_protectionspopup_click_data_reviews 206 notification_emails: *security_ui_protectionspopup_click_emails 207 expires: never 208 extra_keys: 209 value: 210 description: > 211 The `value` of the event. Mirrors to the Legacy Telemetry 212 event's `value` parameter. 213 type: string 214 telemetry_mirror: SecurityUiProtectionspopup_Click_SubviewSettings 215 216 click_settings: 217 type: event 218 description: > 219 User interaction by click events in the protections panel. 220 This event was generated to correspond to the Legacy Telemetry event 221 security.ui.protectionspopup.click#settings. 222 bugs: *security_ui_protectionspopup_click_bugs 223 data_reviews: *security_ui_protectionspopup_click_data_reviews 224 notification_emails: *security_ui_protectionspopup_click_emails 225 expires: never 226 telemetry_mirror: SecurityUiProtectionspopup_Click_Settings 227 228 click_full_report: 229 type: event 230 description: > 231 User interaction by click events in the protections panel. 232 This event was generated to correspond to the Legacy Telemetry event 233 security.ui.protectionspopup.click#full_report. 234 bugs: *security_ui_protectionspopup_click_bugs 235 data_reviews: *security_ui_protectionspopup_click_data_reviews 236 notification_emails: *security_ui_protectionspopup_click_emails 237 expires: never 238 telemetry_mirror: SecurityUiProtectionspopup_Click_FullReport 239 240 click_milestone_message: 241 type: event 242 description: > 243 User interaction by click events in the protections panel. 244 This event was generated to correspond to the Legacy Telemetry event 245 security.ui.protectionspopup.click#milestone_message. 246 bugs: *security_ui_protectionspopup_click_bugs 247 data_reviews: *security_ui_protectionspopup_click_data_reviews 248 notification_emails: *security_ui_protectionspopup_click_emails 249 expires: never 250 telemetry_mirror: SecurityUiProtectionspopup_Click_MilestoneMessage 251 252 click_cookieb_toggle_on: 253 type: event 254 description: > 255 User interaction by click events in the protections panel. 256 This event was generated to correspond to the Legacy Telemetry event 257 security.ui.protectionspopup.click#cookieb_toggle_on. 258 bugs: *security_ui_protectionspopup_click_bugs 259 data_reviews: *security_ui_protectionspopup_click_data_reviews 260 notification_emails: *security_ui_protectionspopup_click_emails 261 expires: never 262 telemetry_mirror: SecurityUiProtectionspopup_Click_CookiebToggleOn 263 264 click_cookieb_toggle_off: 265 type: event 266 description: > 267 User interaction by click events in the protections panel. 268 This event was generated to correspond to the Legacy Telemetry event 269 security.ui.protectionspopup.click#cookieb_toggle_off. 270 bugs: *security_ui_protectionspopup_click_bugs 271 data_reviews: *security_ui_protectionspopup_click_data_reviews 272 notification_emails: *security_ui_protectionspopup_click_emails 273 expires: never 274 telemetry_mirror: SecurityUiProtectionspopup_Click_CookiebToggleOff 275 276 click_protectionspopup_cfr: 277 type: event 278 description: > 279 User interaction by click events in the protections panel. 280 This event was generated to correspond to the Legacy Telemetry event 281 security.ui.protectionspopup.click#protectionspopup_cfr. 282 bugs: *security_ui_protectionspopup_click_bugs 283 data_reviews: *security_ui_protectionspopup_click_data_reviews 284 notification_emails: *security_ui_protectionspopup_click_emails 285 expires: never 286 extra_keys: *security_ui_protectionspopup_open_extra 287 telemetry_mirror: SecurityUiProtectionspopup_Click_ProtectionspopupCfr 288 289 click_smartblockembeds_toggle: 290 type: event 291 description: > 292 Triggered when SmartBlock embed toggles are clicked by the user 293 extra_keys: 294 isBlock: 295 description: > 296 boolean representing if this was a block or an unblock 297 type: boolean 298 openingReason: 299 description: > 300 string representing how the protections panel was opened, 301 one of ["shieldButtonClicked", "embedPlaceholderButton", "toastButtonClicked"] 302 type: string 303 bugs: 304 - https://bugzil.la/1920735 305 - https://bugzil.la/1958162 306 - https://bugzil.la/1989192 307 data_reviews: 308 - https://bugzil.la/1920735 309 notification_emails: 310 - wwen@mozilla.com 311 - emz@mozilla.com 312 expires: 152 313 314 smartblockembeds_shown: 315 type: counter 316 description: > 317 How many times the SmartBlock placeholders are shown on the page 318 bugs: 319 - https://bugzil.la/1920735 320 - https://bugzil.la/1958162 321 - https://bugzil.la/1989192 322 data_reviews: 323 - https://bugzil.la/1920735 324 notification_emails: 325 - wwen@mozilla.com 326 - emz@mozilla.com 327 expires: 152 328 329 browser.engagement: 330 bookmarks_toolbar_bookmark_added: 331 type: counter 332 description: > 333 The count of bookmarks added to the bookmarks toolbar. This counts 334 bookmarks created on the bookmarks toolbar and bookmarks moved to 335 the bookmarks toolbar. 336 This metric was generated to correspond to the Legacy Telemetry 337 scalar browser.engagement.bookmarks_toolbar_bookmark_added. 338 bugs: 339 - https://bugzil.la/1665391 340 data_reviews: 341 - https://bugzil.la/1665391 342 notification_emails: 343 - rtestard@mozilla.com 344 expires: never 345 telemetry_mirror: BROWSER_ENGAGEMENT_BOOKMARKS_TOOLBAR_BOOKMARK_ADDED 346 347 bookmarks_toolbar_bookmark_opened: 348 type: counter 349 description: > 350 The count of bookmarks opened from the Bookmarks Toolbar. This 351 counts bookmarks opened on the toolbar and bookmarks opened from the 352 'symlinked' Other Bookmarks folder on the Bookmarks Toolbar. It does 353 not count Bookmarks Toolbar bookmarks opened via the Library, 354 Bookmarks Menu, or other UI since the goal is to measure 355 interactions that pass through the toolbar. 356 This metric was generated to correspond to the Legacy Telemetry 357 scalar browser.engagement.bookmarks_toolbar_bookmark_opened. 358 bugs: 359 - https://bugzil.la/1665391 360 data_reviews: 361 - https://bugzil.la/1665391 362 notification_emails: 363 - rtestard@mozilla.com 364 expires: never 365 telemetry_mirror: BROWSER_ENGAGEMENT_BOOKMARKS_TOOLBAR_BOOKMARK_OPENED 366 367 total_top_visits: 368 type: labeled_counter 369 description: > 370 Count the number of times a new top page was starting to load 371 372 This metric was generated to correspond to the Legacy Telemetry boolean 373 histogram FX_TOTAL_TOP_VISITS. 374 labels: 375 - "false" 376 - "true" 377 bugs: 378 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 379 data_reviews: 380 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 381 notification_emails: 382 - mconley@mozilla.com 383 expires: never 384 telemetry_mirror: h#FX_TOTAL_TOP_VISITS 385 386 networking: 387 captive_portal_banner_displayed: 388 type: counter 389 description: > 390 Number of times the captive portal banner was displayed in this 391 session. 392 This metric was generated to correspond to the Legacy Telemetry 393 scalar networking.captive_portal_banner_displayed. 394 bugs: 395 - https://bugzil.la/1868145 396 data_reviews: 397 - https://bugzil.la/1868145 398 notification_emails: 399 - necko@mozilla.com 400 expires: never 401 telemetry_mirror: NETWORKING_CAPTIVE_PORTAL_BANNER_DISPLAYED 402 403 captive_portal_banner_display_time: 404 type: labeled_counter 405 description: > 406 Number of seconds the captive portal banner was displayed for, keyed 407 by close reason: 408 "success" - the portal login was completed 409 "abort" - the portal login was aborted (e.g. loss of network) 410 "dismiss" - the user dismissed the banner 411 This metric was generated to correspond to the Legacy Telemetry 412 scalar networking.captive_portal_banner_display_time. 413 bugs: 414 - https://bugzil.la/1868145 415 data_reviews: 416 - https://bugzil.la/1868145 417 notification_emails: 418 - necko@mozilla.com 419 expires: never 420 labels: 421 - success 422 - abort 423 - dismiss 424 telemetry_mirror: NETWORKING_CAPTIVE_PORTAL_BANNER_DISPLAY_TIME 425 426 browser.timings: 427 tab_click: 428 type: timing_distribution 429 description: > 430 Firefox: Time in ms spent on switching tabs in response to a tab click 431 432 This metric was generated to correspond to the Legacy Telemetry 433 exponential histogram FX_TAB_CLICK_MS. 434 time_unit: millisecond 435 bugs: 436 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 437 data_reviews: 438 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 439 notification_emails: 440 - mconley@mozilla.com 441 expires: never 442 telemetry_mirror: FX_TAB_CLICK_MS 443 444 new_window: 445 type: timing_distribution 446 description: > 447 Firefox: Time taken to open a new browser window (ms) 448 449 This metric was generated to correspond to the Legacy Telemetry 450 exponential histogram FX_NEW_WINDOW_MS. 451 time_unit: millisecond 452 bugs: 453 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 454 data_reviews: 455 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 456 notification_emails: 457 - mconley@mozilla.com 458 expires: never 459 telemetry_mirror: FX_NEW_WINDOW_MS 460 461 page_load: 462 type: timing_distribution 463 description: > 464 Firefox: Time taken to load a page (ms). This includes all static 465 contents, no dynamic content. Page reloads and loading of about: pages are 466 not included. 467 468 This metric was generated to correspond to the Legacy Telemetry linear 469 histogram FX_PAGE_LOAD_MS_2. 470 time_unit: millisecond 471 bugs: 472 - https://bugzilla.mozilla.org/show_bug.cgi?id=1504247 473 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 474 data_reviews: 475 - https://bugzilla.mozilla.org/show_bug.cgi?id=1504247 476 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 477 notification_emails: 478 - perf-telemetry-alerts@mozilla.com 479 - product-metrics-telemetry-alerts@mozilla.com 480 expires: never 481 telemetry_mirror: FX_PAGE_LOAD_MS_2 482 483 page_reload_normal: 484 type: timing_distribution 485 description: > 486 Firefox: Time taken to reload a page (ms) when using the 487 LOAD_RELOAD_NORMAL flag 488 489 This metric was generated to correspond to the Legacy Telemetry linear 490 histogram FX_PAGE_RELOAD_NORMAL_MS. 491 time_unit: millisecond 492 bugs: 493 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 494 data_reviews: 495 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 496 notification_emails: 497 - sefeng@mozilla.com 498 - perf-telemetry-alerts@mozilla.com 499 - product-metrics-telemetry-alerts@mozilla.com 500 expires: never 501 telemetry_mirror: FX_PAGE_RELOAD_NORMAL_MS 502 503 page_reload_skip_cache: 504 type: timing_distribution 505 description: > 506 Firefox: Time taken to reload a page (ms) when caches are skipped 507 508 This metric was generated to correspond to the Legacy Telemetry linear 509 histogram FX_PAGE_RELOAD_SKIP_CACHE_MS. 510 time_unit: millisecond 511 bugs: 512 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 513 data_reviews: 514 - https://bugzilla.mozilla.org/show_bug.cgi?id=1549519 515 notification_emails: 516 - sefeng@mozilla.com 517 - perf-telemetry-alerts@mozilla.com 518 - product-metrics-telemetry-alerts@mozilla.com 519 expires: never 520 telemetry_mirror: FX_PAGE_RELOAD_SKIP_CACHE_MS 521 522 startup_timeline: 523 type: labeled_quantity 524 unit: milliseconds since process creation 525 lifetime: application 526 description: | 527 Events on the startup timeline, in millis since process creation. 528 Previously carried in the Legacy "main" ping `simpleMeasurements`. 529 bugs: 530 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 531 data_reviews: 532 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 533 notification_emails: 534 - sefeng@mozilla.com 535 - perf-telemetry-alerts@mozilla.com 536 - product-metrics-telemetry-alerts@mozilla.com 537 expires: never 538 data_sensitivity: 539 - technical 540 labels: 541 - delayedStartupStarted 542 - delayedStartupFinished 543 - blankWindowShown