metrics.yaml (19967B)
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 :: Sidebar' 12 13 sidebar: 14 expand: 15 type: event 16 description: > 17 The sidebar was expanded. 18 bugs: 19 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 20 data_reviews: 21 - https://phabricator.services.mozilla.com/D220720 22 data_sensitivity: 23 - interaction 24 expires: never 25 notification_emails: 26 - vsabino@mozilla.com 27 send_in_pings: 28 - events 29 resize: 30 type: event 31 description: > 32 User resized the sidebar. 33 bugs: 34 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 35 data_reviews: 36 - https://phabricator.services.mozilla.com/D220720 37 data_sensitivity: 38 - interaction 39 expires: never 40 notification_emails: 41 - vsabino@mozilla.com 42 send_in_pings: 43 - events 44 extra_keys: 45 current: 46 type: quantity 47 description: Current width in pixels. 48 previous: 49 type: quantity 50 description: Previous width in pixels. 51 percentage: 52 type: quantity 53 description: Percentage of window width at time of resize (0-100). 54 display_settings: 55 type: string 56 lifetime: application 57 description: > 58 Setting for sidebar display (either "always", "expand-on-hover", or "hide"). 59 bugs: 60 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 61 data_reviews: 62 - https://phabricator.services.mozilla.com/D220720 63 data_sensitivity: 64 - interaction 65 expires: never 66 notification_emails: 67 - vsabino@mozilla.com 68 send_in_pings: 69 - metrics 70 position_settings: 71 type: string 72 lifetime: application 73 description: > 74 Setting for sidebar position (either "left" or "right"). 75 bugs: 76 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 77 data_reviews: 78 - https://phabricator.services.mozilla.com/D220720 79 data_sensitivity: 80 - interaction 81 expires: never 82 notification_emails: 83 - vsabino@mozilla.com 84 send_in_pings: 85 - metrics 86 tabs_layout: 87 type: string 88 lifetime: application 89 description: > 90 Setting for tabs orientation (either "horizontal" or "vertical"). 91 bugs: 92 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 93 data_reviews: 94 - https://phabricator.services.mozilla.com/D220720 95 data_sensitivity: 96 - interaction 97 expires: never 98 notification_emails: 99 - vsabino@mozilla.com 100 send_in_pings: 101 - metrics 102 width: 103 type: quantity 104 unit: pixels 105 lifetime: application 106 description: > 107 Width of the sidebar, in pixels. 108 bugs: 109 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 110 data_reviews: 111 - https://phabricator.services.mozilla.com/D220720 112 data_sensitivity: 113 - interaction 114 expires: never 115 notification_emails: 116 - vsabino@mozilla.com 117 send_in_pings: 118 - metrics 119 search: 120 type: labeled_counter 121 description: > 122 The number of searches from the sidebar, per view (e.g.: bookmarks, 123 history). 124 This metric was generated to correspond to the Legacy Telemetry 125 scalar sidebar.search. 126 bugs: 127 - https://bugzil.la/1648524 128 data_reviews: 129 - https://bugzil.la/1648524 130 notification_emails: 131 - rtestard@mozilla.com 132 expires: never 133 telemetry_mirror: SIDEBAR_SEARCH 134 link: 135 type: labeled_counter 136 description: > 137 The number of history items opened from the History sidebar. 138 This metric was generated to correspond to the Legacy Telemetry 139 scalar sidebar.link. 140 bugs: 141 - https://bugzil.la/1815706 142 data_reviews: 143 - https://bugzil.la/1815706 144 notification_emails: 145 - rtestard@mozilla.com 146 expires: never 147 telemetry_mirror: SIDEBAR_LINK 148 chatbot_icon_click: 149 type: event 150 description: > 151 The chatbot icon was clicked. 152 bugs: 153 - https://bugzil.la/1923972 154 data_reviews: 155 - https://phabricator.services.mozilla.com/D226681 156 data_sensitivity: 157 - interaction 158 expires: never 159 notification_emails: 160 - vsabino@mozilla.com 161 send_in_pings: 162 - events 163 extra_keys: 164 sidebar_open: 165 type: boolean 166 description: Whether the sidebar is expanded or collapsed. 167 history_icon_click: 168 type: event 169 description: > 170 The history icon was clicked. 171 bugs: 172 - https://bugzil.la/1923972 173 data_reviews: 174 - https://phabricator.services.mozilla.com/D226681 175 data_sensitivity: 176 - interaction 177 expires: never 178 notification_emails: 179 - vsabino@mozilla.com 180 send_in_pings: 181 - events 182 extra_keys: 183 sidebar_open: 184 type: boolean 185 description: Whether the sidebar is expanded or collapsed. 186 synced_tabs_icon_click: 187 type: event 188 description: > 189 The synced tabs icon was clicked. 190 bugs: 191 - https://bugzil.la/1923972 192 data_reviews: 193 - https://phabricator.services.mozilla.com/D226681 194 data_sensitivity: 195 - interaction 196 expires: never 197 notification_emails: 198 - vsabino@mozilla.com 199 send_in_pings: 200 - events 201 extra_keys: 202 sidebar_open: 203 type: boolean 204 description: Whether the sidebar is expanded or collapsed. 205 bookmarks_icon_click: 206 type: event 207 description: > 208 The bookmarks icon was clicked. 209 bugs: 210 - https://bugzil.la/1923972 211 data_reviews: 212 - https://phabricator.services.mozilla.com/D226681 213 data_sensitivity: 214 - interaction 215 expires: never 216 notification_emails: 217 - vsabino@mozilla.com 218 send_in_pings: 219 - events 220 extra_keys: 221 sidebar_open: 222 type: boolean 223 description: Whether the sidebar is expanded or collapsed. 224 addon_icon_click: 225 type: event 226 description: > 227 An extension icon was clicked. 228 bugs: 229 - https://bugzil.la/1923972 230 data_reviews: 231 - https://phabricator.services.mozilla.com/D226681 232 data_sensitivity: 233 - interaction 234 expires: never 235 notification_emails: 236 - vsabino@mozilla.com 237 send_in_pings: 238 - events 239 extra_keys: 240 sidebar_open: 241 type: boolean 242 description: Whether the sidebar is expanded or collapsed. 243 addon_id: 244 type: string 245 description: The extension's ID. 246 keyboard_shortcut: 247 type: event 248 description: > 249 Revamped sidebar toggled with keyboard shortcut. 250 bugs: 251 - https://bugzilla.mozilla.org/show_bug.cgi?id=1897411 252 data_reviews: 253 - https://phabricator.services.mozilla.com/D229405 254 data_sensitivity: 255 - interaction 256 expires: never 257 notification_emails: 258 - vsabino@mozilla.com 259 send_in_pings: 260 - events 261 extra_keys: 262 panel: 263 type: string 264 description: Sidebar panel is currently open if any. 265 opened: 266 type: boolean 267 description: Whether the sidebar is opening 268 history: 269 sidebar_toggle: 270 type: event 271 description: > 272 The History sidebar panel was loaded or unloaded. 273 bugs: 274 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 275 data_reviews: 276 - https://phabricator.services.mozilla.com/D220720 277 data_sensitivity: 278 - interaction 279 expires: never 280 notification_emails: 281 - vsabino@mozilla.com 282 send_in_pings: 283 - events 284 extra_keys: 285 opened: 286 type: boolean 287 description: Whether the panel was opened. 288 version: 289 type: string 290 description: The active version of sidebar (either "old" or "new"). 291 synced_tabs: 292 sidebar_toggle: 293 type: event 294 description: > 295 The Synced Tabs sidebar panel was loaded or unloaded. 296 bugs: 297 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 298 data_reviews: 299 - https://phabricator.services.mozilla.com/D220720 300 data_sensitivity: 301 - interaction 302 expires: never 303 notification_emails: 304 - vsabino@mozilla.com 305 send_in_pings: 306 - events 307 extra_keys: 308 opened: 309 type: boolean 310 description: Whether the panel was opened. 311 synced_tabs_loaded: 312 type: boolean 313 description: Whether synced tabs are showing. 314 version: 315 type: string 316 description: The active version of sidebar (either "old" or "new"). 317 bookmarks: 318 sidebar_toggle: 319 type: event 320 description: > 321 The Bookmarks sidebar panel was loaded or unloaded. 322 bugs: 323 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 324 data_reviews: 325 - https://phabricator.services.mozilla.com/D220720 326 data_sensitivity: 327 - interaction 328 expires: never 329 notification_emails: 330 - vsabino@mozilla.com 331 send_in_pings: 332 - events 333 extra_keys: 334 opened: 335 type: boolean 336 description: Whether the panel was opened. 337 version: 338 type: string 339 description: The active version of sidebar (either "old" or "new"). 340 extension: 341 sidebar_toggle: 342 type: event 343 description: > 344 A sidebar extension panel was loaded or unloaded. 345 bugs: 346 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 347 data_reviews: 348 - https://phabricator.services.mozilla.com/D220720 349 data_sensitivity: 350 - interaction 351 expires: never 352 notification_emails: 353 - vsabino@mozilla.com 354 send_in_pings: 355 - events 356 extra_keys: 357 opened: 358 type: boolean 359 description: Whether the panel was opened. 360 addon_id: 361 type: string 362 description: The extension's ID. 363 addon_name: 364 type: string 365 description: The localized name of the extension. 366 version: 367 type: string 368 description: The active version of sidebar (either "old" or "new"). 369 sidebar.customize: 370 panel_toggle: 371 type: event 372 description: > 373 The Customize sidebar panel was loaded or unloaded. 374 bugs: 375 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 376 data_reviews: 377 - https://phabricator.services.mozilla.com/D220720 378 data_sensitivity: 379 - interaction 380 expires: never 381 notification_emails: 382 - vsabino@mozilla.com 383 send_in_pings: 384 - events 385 extra_keys: 386 opened: 387 type: boolean 388 description: Whether the panel was opened. 389 icon_click: 390 type: event 391 description: > 392 User clicked on the gear icon to customize the sidebar. 393 bugs: 394 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 395 data_reviews: 396 - https://phabricator.services.mozilla.com/D220720 397 data_sensitivity: 398 - interaction 399 expires: never 400 notification_emails: 401 - vsabino@mozilla.com 402 send_in_pings: 403 - events 404 chatbot_enabled: 405 type: event 406 description: > 407 User clicked on the checkbox corresponding to chatbot on sidebar customization settings. 408 bugs: 409 - https://bugzilla.mozilla.org/show_bug.cgi?id=1923900 410 data_reviews: 411 - https://phabricator.services.mozilla.com/D225304 412 data_sensitivity: 413 - interaction 414 expires: never 415 notification_emails: 416 - vsabino@mozilla.com 417 send_in_pings: 418 - events 419 extra_keys: 420 checked: 421 type: boolean 422 description: Whether the box was checked. 423 synced_tabs_enabled: 424 type: event 425 description: > 426 User clicked on the checkbox corresponding to synced tabs on sidebar customization settings. 427 bugs: 428 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 429 data_reviews: 430 - https://phabricator.services.mozilla.com/D220720 431 data_sensitivity: 432 - interaction 433 expires: never 434 notification_emails: 435 - vsabino@mozilla.com 436 send_in_pings: 437 - events 438 extra_keys: 439 checked: 440 type: boolean 441 description: Whether the box was checked. 442 history_enabled: 443 type: event 444 description: > 445 User clicked on the checkbox corresponding to history on sidebar customization settings. 446 bugs: 447 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 448 data_reviews: 449 - https://phabricator.services.mozilla.com/D220720 450 data_sensitivity: 451 - interaction 452 expires: never 453 notification_emails: 454 - vsabino@mozilla.com 455 send_in_pings: 456 - events 457 extra_keys: 458 checked: 459 type: boolean 460 description: Whether the box was checked. 461 bookmarks_enabled: 462 type: event 463 description: > 464 User clicked on the checkbox corresponding to bookmarks on sidebar customization settings. 465 bugs: 466 - https://bugzilla.mozilla.org/show_bug.cgi?id=1923900 467 data_reviews: 468 - https://phabricator.services.mozilla.com/D225304 469 data_sensitivity: 470 - interaction 471 expires: never 472 notification_emails: 473 - vsabino@mozilla.com 474 send_in_pings: 475 - events 476 extra_keys: 477 checked: 478 type: boolean 479 description: Whether the box was checked. 480 extensions_clicked: 481 type: event 482 description: > 483 User clicked on the link to go to Browser Extensions on sidebar customization settings. 484 bugs: 485 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 486 data_reviews: 487 - https://phabricator.services.mozilla.com/D220720 488 data_sensitivity: 489 - interaction 490 expires: never 491 notification_emails: 492 - vsabino@mozilla.com 493 send_in_pings: 494 - events 495 sidebar_display: 496 type: event 497 description: > 498 User selected an option of when the sidebar is shown on sidebar customization settings. 499 bugs: 500 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 501 data_reviews: 502 - https://phabricator.services.mozilla.com/D220720 503 data_sensitivity: 504 - interaction 505 expires: never 506 notification_emails: 507 - vsabino@mozilla.com 508 send_in_pings: 509 - events 510 extra_keys: 511 preference: 512 type: string 513 description: Either "always" or "hide". 514 sidebar_position: 515 type: event 516 description: > 517 User selected an option of in which side the sidebar is displayed from the sidebar customization settings. 518 bugs: 519 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 520 data_reviews: 521 - https://phabricator.services.mozilla.com/D220720 522 data_sensitivity: 523 - interaction 524 expires: never 525 notification_emails: 526 - vsabino@mozilla.com 527 send_in_pings: 528 - events 529 extra_keys: 530 position: 531 type: string 532 description: Either "left" or "right". 533 tabs_layout: 534 type: event 535 description: > 536 User selected between horizontal or vertical tabs on sidebar customization settings. 537 bugs: 538 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 539 data_reviews: 540 - https://phabricator.services.mozilla.com/D220720 541 data_sensitivity: 542 - interaction 543 expires: never 544 notification_emails: 545 - vsabino@mozilla.com 546 send_in_pings: 547 - events 548 extra_keys: 549 orientation: 550 type: string 551 description: Either "horizontal" or "vertical". 552 tabs_display: 553 type: event 554 description: > 555 User clicked on the checkbox corresponding to hiding horizontal tabs on sidebar customization settings. 556 bugs: 557 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 558 data_reviews: 559 - https://phabricator.services.mozilla.com/D220720 560 data_sensitivity: 561 - interaction 562 expires: never 563 notification_emails: 564 - vsabino@mozilla.com 565 send_in_pings: 566 - events 567 extra_keys: 568 checked: 569 type: boolean 570 description: Whether the box was checked. 571 firefox_settings_clicked: 572 type: event 573 description: > 574 User clicked on the link to Manage Firefox Settings on sidebar customization settings. 575 bugs: 576 - https://bugzilla.mozilla.org/show_bug.cgi?id=1898250 577 data_reviews: 578 - https://phabricator.services.mozilla.com/D220720 579 data_sensitivity: 580 - interaction 581 expires: never 582 notification_emails: 583 - vsabino@mozilla.com 584 send_in_pings: 585 - events 586 expand_on_hover_enabled: 587 type: event 588 description: > 589 User clicked on the checkbox corresponding to expand on hover on sidebar customization settings. 590 bugs: 591 - https://bugzilla.mozilla.org/show_bug.cgi?id=1930201 592 data_reviews: 593 - https://phabricator.services.mozilla.com/D233098 594 data_sensitivity: 595 - interaction 596 expires: never 597 notification_emails: 598 - vsabino@mozilla.com 599 send_in_pings: 600 - events 601 extra_keys: 602 checked: 603 type: boolean 604 description: Whether the box was checked. 605 contextual_manager: 606 sidebar_toggle: 607 type: event 608 description: Client opens Contextual Manager. 609 bugs: 610 - https://bugzilla.mozilla.org/show_bug.cgi?id=1946830 611 data_reviews: 612 - https://bugzilla.mozilla.org/show_bug.cgi?id=1947634 613 data_sensitivity: 614 - interaction 615 expires: never 616 notification_emails: 617 - issozi@mozilla.com 618 - tthorne@mozilla.com 619 - passwords-dev@mozilla.org 620 send_in_pings: 621 - events 622 extra_keys: 623 opened: 624 type: boolean 625 description: Whether the sidebar is opening. 626 passwords_enabled: 627 type: event 628 description: > 629 User clicked on the checkbox corresponding to the "Passwords" entry on sidebar customization settings. 630 bugs: 631 - https://bugzilla.mozilla.org/show_bug.cgi?id=1956952 632 data_reviews: 633 - https://bugzilla.mozilla.org/show_bug.cgi?id=1947634 634 data_sensitivity: 635 - interaction 636 expires: never 637 notification_emails: 638 - issozi@mozilla.com 639 - tthorne@mozilla.com 640 - passwords-dev@mozilla.org 641 send_in_pings: 642 - events 643 extra_keys: 644 checked: 645 type: boolean 646 description: Whether the Passwords box was checked. 647 pinned_tabs: 648 activations: 649 type: labeled_counter 650 description: > 651 Records how many times a pinned tab gets activated. 652 bugs: 653 - https://bugzil.la/1966761 654 data_reviews: 655 - https://phabricator.services.mozilla.com/D253888 656 data_sensitivity: 657 - interaction 658 expires: never 659 notification_emails: 660 - vsabino@mozilla.com 661 send_in_pings: 662 - metrics 663 labels: 664 - sidebar 665 - horizontal_bar 666 count: 667 type: labeled_quantity 668 description: > 669 Records how many pinned tabs the user currently has across all windows. 670 bugs: 671 - https://bugzil.la/1966761 672 data_reviews: 673 - https://phabricator.services.mozilla.com/D253888 674 data_sensitivity: 675 - interaction 676 expires: never 677 notification_emails: 678 - vsabino@mozilla.com 679 send_in_pings: 680 - metrics 681 labels: 682 - sidebar 683 - horizontal_bar 684 pin: 685 type: event 686 description: > 687 Recorded when a user pins a tab. 688 bugs: 689 - https://bugzil.la/1966761 690 data_reviews: 691 - https://phabricator.services.mozilla.com/D253888 692 data_sensitivity: 693 - interaction 694 expires: never 695 notification_emails: 696 - vsabino@mozilla.com 697 send_in_pings: 698 - events 699 extra_keys: 700 layout: 701 type: string 702 description: Either "horizontal" or "vertical". 703 source: 704 type: string 705 description: Either "tab_menu", "drag", or "unknown". 706 close: 707 type: event 708 description: > 709 Recorded when a user closes a pinned tab. 710 bugs: 711 - https://bugzil.la/1966761 712 data_reviews: 713 - https://phabricator.services.mozilla.com/D253888 714 data_sensitivity: 715 - interaction 716 expires: never 717 notification_emails: 718 - vsabino@mozilla.com 719 send_in_pings: 720 - events 721 extra_keys: 722 layout: 723 type: string 724 description: Either "horizontal" or "vertical".