metrics.yaml (41586B)
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 :: Sync' 12 13 synced_tabs: 14 click_fxa_avatar_menu: 15 type: event 16 description: > 17 Record how users access and use synced tabs component 18 This event was generated to correspond to the Legacy Telemetry event 19 synced_tabs.click#fxa_avatar_menu. 20 bugs: &synced_tabs_click_bugs 21 - https://bugzil.la/1756252 22 data_reviews: &synced_tabs_click_data_reviews 23 - https://bugzil.la/1756252 24 notification_emails: &synced_tabs_click_emails 25 - sync-dev@mozilla.org 26 expires: never 27 extra_keys: &synced_tabs_click_extra 28 tab_pos: 29 description: > 30 position of the tab clicked 31 type: string 32 filter: 33 description: > 34 was there a filter enabled 35 type: string 36 telemetry_mirror: Synced_tabs_Click_FxaAvatarMenu 37 no_lint: 38 - COMMON_PREFIX 39 40 click_fxa_app_menu: 41 type: event 42 description: > 43 Record how users access and use synced tabs component 44 This event was generated to correspond to the Legacy Telemetry event 45 synced_tabs.click#fxa_app_menu. 46 bugs: *synced_tabs_click_bugs 47 data_reviews: *synced_tabs_click_data_reviews 48 notification_emails: *synced_tabs_click_emails 49 expires: never 50 extra_keys: *synced_tabs_click_extra 51 telemetry_mirror: Synced_tabs_Click_FxaAppMenu 52 no_lint: 53 - COMMON_PREFIX 54 55 click_synced_tabs_sidebar: 56 type: event 57 description: > 58 Record how users access and use synced tabs component 59 This event was generated to correspond to the Legacy Telemetry event 60 synced_tabs.click#synced_tabs_sidebar. 61 bugs: *synced_tabs_click_bugs 62 data_reviews: *synced_tabs_click_data_reviews 63 notification_emails: *synced_tabs_click_emails 64 expires: never 65 extra_keys: *synced_tabs_click_extra 66 telemetry_mirror: Synced_tabs_Click_SyncedTabsSidebar 67 no_lint: 68 - COMMON_PREFIX 69 70 fxa_avatar_menu: 71 click_account_settings: 72 type: event 73 description: > 74 This is recorded on interactions with the FxA avatar menu on the 75 toolbar 76 This event was generated to correspond to the Legacy Telemetry event 77 fxa_avatar_menu.click#account_settings. 78 bugs: &fxa_avatar_menu_click_bugs 79 - https://bugzil.la/1524665 80 - https://bugzil.la/1585459 81 - https://bugzil.la/1606203 82 data_reviews: &fxa_avatar_menu_click_data_reviews 83 - https://bugzil.la/1524665 84 - https://bugzil.la/1585459 85 - https://bugzil.la/1606203 86 notification_emails: &fxa_avatar_menu_click_emails 87 - vbudhram@mozilla.com 88 - loines@mozilla.com 89 expires: never 90 extra_keys: &fxa_avatar_menu_click_extra 91 fxa_status: 92 description: > 93 The current state of the user. Possible states are "not_configured", "unverified", "signedin" and "login_failed". 94 95 type: string 96 fxa_avatar: 97 description: > 98 Boolean for whether or not account has set an avatar 99 type: string 100 fxa_sync_on: 101 description: > 102 Boolean for whether or not sync was configured at the time the event fired. 103 type: string 104 telemetry_mirror: Fxa_avatar_menu_Click_AccountSettings 105 no_lint: 106 - COMMON_PREFIX 107 108 click_cad: 109 type: event 110 description: > 111 This is recorded on interactions with the FxA avatar menu on the 112 toolbar 113 This event was generated to correspond to the Legacy Telemetry event 114 fxa_avatar_menu.click#cad. 115 bugs: *fxa_avatar_menu_click_bugs 116 data_reviews: *fxa_avatar_menu_click_data_reviews 117 notification_emails: *fxa_avatar_menu_click_emails 118 expires: never 119 extra_keys: *fxa_avatar_menu_click_extra 120 telemetry_mirror: Fxa_avatar_menu_Click_Cad 121 no_lint: 122 - COMMON_PREFIX 123 124 click_login: 125 type: event 126 description: > 127 This is recorded on interactions with the FxA avatar menu on the 128 toolbar 129 This event was generated to correspond to the Legacy Telemetry event 130 fxa_avatar_menu.click#login. 131 bugs: *fxa_avatar_menu_click_bugs 132 data_reviews: *fxa_avatar_menu_click_data_reviews 133 notification_emails: *fxa_avatar_menu_click_emails 134 expires: never 135 extra_keys: *fxa_avatar_menu_click_extra 136 telemetry_mirror: Fxa_avatar_menu_Click_Login 137 no_lint: 138 - COMMON_PREFIX 139 140 click_send_tab: 141 type: event 142 description: > 143 This is recorded on interactions with the FxA avatar menu on the 144 toolbar 145 This event was generated to correspond to the Legacy Telemetry event 146 fxa_avatar_menu.click#send_tab. 147 bugs: *fxa_avatar_menu_click_bugs 148 data_reviews: *fxa_avatar_menu_click_data_reviews 149 notification_emails: *fxa_avatar_menu_click_emails 150 expires: never 151 extra_keys: *fxa_avatar_menu_click_extra 152 telemetry_mirror: Fxa_avatar_menu_Click_SendTab 153 no_lint: 154 - COMMON_PREFIX 155 156 click_sync_now: 157 type: event 158 description: > 159 This is recorded on interactions with the FxA avatar menu on the 160 toolbar 161 This event was generated to correspond to the Legacy Telemetry event 162 fxa_avatar_menu.click#sync_now. 163 bugs: *fxa_avatar_menu_click_bugs 164 data_reviews: *fxa_avatar_menu_click_data_reviews 165 notification_emails: *fxa_avatar_menu_click_emails 166 expires: never 167 extra_keys: *fxa_avatar_menu_click_extra 168 telemetry_mirror: Fxa_avatar_menu_Click_SyncNow 169 no_lint: 170 - COMMON_PREFIX 171 172 click_sync_settings: 173 type: event 174 description: > 175 This is recorded on interactions with the FxA avatar menu on the 176 toolbar 177 This event was generated to correspond to the Legacy Telemetry event 178 fxa_avatar_menu.click#sync_settings. 179 bugs: *fxa_avatar_menu_click_bugs 180 data_reviews: *fxa_avatar_menu_click_data_reviews 181 notification_emails: *fxa_avatar_menu_click_emails 182 expires: never 183 extra_keys: *fxa_avatar_menu_click_extra 184 telemetry_mirror: Fxa_avatar_menu_Click_SyncSettings 185 no_lint: 186 - COMMON_PREFIX 187 188 click_sync_tabs: 189 type: event 190 description: > 191 This is recorded on interactions with the FxA avatar menu on the 192 toolbar 193 This event was generated to correspond to the Legacy Telemetry event 194 fxa_avatar_menu.click#sync_tabs. 195 bugs: *fxa_avatar_menu_click_bugs 196 data_reviews: *fxa_avatar_menu_click_data_reviews 197 notification_emails: *fxa_avatar_menu_click_emails 198 expires: never 199 extra_keys: *fxa_avatar_menu_click_extra 200 telemetry_mirror: Fxa_avatar_menu_Click_SyncTabs 201 no_lint: 202 - COMMON_PREFIX 203 204 click_sync_tabs_sidebar: 205 type: event 206 description: > 207 This is recorded on interactions with the FxA avatar menu on the 208 toolbar 209 This event was generated to correspond to the Legacy Telemetry event 210 fxa_avatar_menu.click#sync_tabs_sidebar. 211 bugs: *fxa_avatar_menu_click_bugs 212 data_reviews: *fxa_avatar_menu_click_data_reviews 213 notification_emails: *fxa_avatar_menu_click_emails 214 expires: never 215 extra_keys: *fxa_avatar_menu_click_extra 216 telemetry_mirror: Fxa_avatar_menu_Click_SyncTabsSidebar 217 no_lint: 218 - COMMON_PREFIX 219 220 click_toolbar_icon: 221 type: event 222 description: > 223 This is recorded on interactions with the FxA avatar menu on the 224 toolbar 225 This event was generated to correspond to the Legacy Telemetry event 226 fxa_avatar_menu.click#toolbar_icon. 227 bugs: *fxa_avatar_menu_click_bugs 228 data_reviews: *fxa_avatar_menu_click_data_reviews 229 notification_emails: *fxa_avatar_menu_click_emails 230 expires: never 231 extra_keys: *fxa_avatar_menu_click_extra 232 telemetry_mirror: Fxa_avatar_menu_Click_ToolbarIcon 233 no_lint: 234 - COMMON_PREFIX 235 236 click_unver_sync_settings: 237 type: event 238 description: > 239 This is recorded on interactions with the FxA avatar menu on the 240 toolbar 241 This event was generated to correspond to the Legacy Telemetry event 242 fxa_avatar_menu.click#unver_sync_settings. 243 bugs: *fxa_avatar_menu_click_bugs 244 data_reviews: *fxa_avatar_menu_click_data_reviews 245 notification_emails: *fxa_avatar_menu_click_emails 246 expires: never 247 extra_keys: *fxa_avatar_menu_click_extra 248 telemetry_mirror: Fxa_avatar_menu_Click_UnverSyncSettings 249 no_lint: 250 - COMMON_PREFIX 251 252 click_open_monitor: 253 type: event 254 description: > 255 This is recorded on interactions with the FxA avatar menu on the 256 toolbar 257 This event was generated to correspond to the Legacy Telemetry event 258 fxa_avatar_menu.click#open_monitor. 259 bugs: *fxa_avatar_menu_click_bugs 260 data_reviews: *fxa_avatar_menu_click_data_reviews 261 notification_emails: *fxa_avatar_menu_click_emails 262 expires: never 263 extra_keys: *fxa_avatar_menu_click_extra 264 telemetry_mirror: Fxa_avatar_menu_Click_OpenMonitor 265 no_lint: 266 - COMMON_PREFIX 267 268 click_open_send: 269 type: event 270 description: > 271 This is recorded on interactions with the FxA avatar menu on the 272 toolbar 273 This event was generated to correspond to the Legacy Telemetry event 274 fxa_avatar_menu.click#open_send. 275 bugs: *fxa_avatar_menu_click_bugs 276 data_reviews: *fxa_avatar_menu_click_data_reviews 277 notification_emails: *fxa_avatar_menu_click_emails 278 expires: never 279 extra_keys: *fxa_avatar_menu_click_extra 280 telemetry_mirror: Fxa_avatar_menu_Click_OpenSend 281 no_lint: 282 - COMMON_PREFIX 283 284 click_monitor_cta: 285 type: event 286 description: > 287 This is recorded on interactions with the FxA avatar menu on the 288 toolbar 289 This event was generated to correspond to the Legacy Telemetry event 290 fxa_avatar_menu.click#monitor_cta. 291 bugs: *fxa_avatar_menu_click_bugs 292 data_reviews: *fxa_avatar_menu_click_data_reviews 293 notification_emails: *fxa_avatar_menu_click_emails 294 expires: never 295 extra_keys: *fxa_avatar_menu_click_extra 296 telemetry_mirror: Fxa_avatar_menu_Click_MonitorCta 297 no_lint: 298 - COMMON_PREFIX 299 300 click_relay_cta: 301 type: event 302 description: > 303 This is recorded on interactions with the FxA avatar menu on the 304 toolbar 305 This event was generated to correspond to the Legacy Telemetry event 306 fxa_avatar_menu.click#relay_cta. 307 bugs: *fxa_avatar_menu_click_bugs 308 data_reviews: *fxa_avatar_menu_click_data_reviews 309 notification_emails: *fxa_avatar_menu_click_emails 310 expires: never 311 extra_keys: *fxa_avatar_menu_click_extra 312 telemetry_mirror: Fxa_avatar_menu_Click_RelayCta 313 no_lint: 314 - COMMON_PREFIX 315 316 click_vpn_cta: 317 type: event 318 description: > 319 This is recorded on interactions with the FxA avatar menu on the 320 toolbar 321 This event was generated to correspond to the Legacy Telemetry event 322 fxa_avatar_menu.click#vpn_cta. 323 bugs: *fxa_avatar_menu_click_bugs 324 data_reviews: *fxa_avatar_menu_click_data_reviews 325 notification_emails: *fxa_avatar_menu_click_emails 326 expires: never 327 extra_keys: *fxa_avatar_menu_click_extra 328 telemetry_mirror: Fxa_avatar_menu_Click_VpnCta 329 no_lint: 330 - COMMON_PREFIX 331 332 click_sync_cta: 333 type: event 334 description: > 335 This is recorded on interactions with the FxA avatar menu on the 336 toolbar 337 This event was generated to correspond to the Legacy Telemetry event 338 fxa_avatar_menu.click#sync_cta. 339 bugs: *fxa_avatar_menu_click_bugs 340 data_reviews: *fxa_avatar_menu_click_data_reviews 341 notification_emails: *fxa_avatar_menu_click_emails 342 expires: never 343 extra_keys: *fxa_avatar_menu_click_extra 344 telemetry_mirror: Fxa_avatar_menu_Click_SyncCta 345 no_lint: 346 - COMMON_PREFIX 347 348 fxa_app_menu: 349 click_account_settings: 350 type: event 351 description: > 352 This is recorded on interactions with the FxA menu in the app 353 (hamburger) menu 354 This event was generated to correspond to the Legacy Telemetry event 355 fxa_app_menu.click#account_settings. 356 bugs: &fxa_app_menu_click_bugs 357 - https://bugzil.la/1542334 358 - https://bugzil.la/1606203 359 data_reviews: &fxa_app_menu_click_data_reviews 360 - https://bugzil.la/1542334 361 - https://bugzil.la/1606203 362 notification_emails: &fxa_app_menu_click_emails 363 - vbudhram@mozilla.com 364 - loines@mozilla.com 365 expires: never 366 extra_keys: &fxa_app_menu_click_extra 367 fxa_status: 368 description: > 369 The current state of the user. Possible states are "not_configured", "unverified", "signedin" and "login_failed". 370 371 type: string 372 fxa_avatar: 373 description: > 374 Boolean for whether or not account has set an avatar 375 type: string 376 fxa_sync_on: 377 description: > 378 Boolean for whether or not sync was configured at the time the event fired. 379 type: string 380 telemetry_mirror: Fxa_app_menu_Click_AccountSettings 381 no_lint: 382 - COMMON_PREFIX 383 384 click_cad: 385 type: event 386 description: > 387 This is recorded on interactions with the FxA menu in the app 388 (hamburger) menu 389 This event was generated to correspond to the Legacy Telemetry event 390 fxa_app_menu.click#cad. 391 bugs: *fxa_app_menu_click_bugs 392 data_reviews: *fxa_app_menu_click_data_reviews 393 notification_emails: *fxa_app_menu_click_emails 394 expires: never 395 extra_keys: *fxa_app_menu_click_extra 396 telemetry_mirror: Fxa_app_menu_Click_Cad 397 no_lint: 398 - COMMON_PREFIX 399 400 click_login: 401 type: event 402 description: > 403 This is recorded on interactions with the FxA menu in the app 404 (hamburger) menu 405 This event was generated to correspond to the Legacy Telemetry event 406 fxa_app_menu.click#login. 407 bugs: *fxa_app_menu_click_bugs 408 data_reviews: *fxa_app_menu_click_data_reviews 409 notification_emails: *fxa_app_menu_click_emails 410 expires: never 411 extra_keys: *fxa_app_menu_click_extra 412 telemetry_mirror: Fxa_app_menu_Click_Login 413 no_lint: 414 - COMMON_PREFIX 415 416 click_send_tab: 417 type: event 418 description: > 419 This is recorded on interactions with the FxA menu in the app 420 (hamburger) menu 421 This event was generated to correspond to the Legacy Telemetry event 422 fxa_app_menu.click#send_tab. 423 bugs: *fxa_app_menu_click_bugs 424 data_reviews: *fxa_app_menu_click_data_reviews 425 notification_emails: *fxa_app_menu_click_emails 426 expires: never 427 extra_keys: *fxa_app_menu_click_extra 428 telemetry_mirror: Fxa_app_menu_Click_SendTab 429 no_lint: 430 - COMMON_PREFIX 431 432 click_sync_now: 433 type: event 434 description: > 435 This is recorded on interactions with the FxA menu in the app 436 (hamburger) menu 437 This event was generated to correspond to the Legacy Telemetry event 438 fxa_app_menu.click#sync_now. 439 bugs: *fxa_app_menu_click_bugs 440 data_reviews: *fxa_app_menu_click_data_reviews 441 notification_emails: *fxa_app_menu_click_emails 442 expires: never 443 extra_keys: *fxa_app_menu_click_extra 444 telemetry_mirror: Fxa_app_menu_Click_SyncNow 445 no_lint: 446 - COMMON_PREFIX 447 448 click_sync_settings: 449 type: event 450 description: > 451 This is recorded on interactions with the FxA menu in the app 452 (hamburger) menu 453 This event was generated to correspond to the Legacy Telemetry event 454 fxa_app_menu.click#sync_settings. 455 bugs: *fxa_app_menu_click_bugs 456 data_reviews: *fxa_app_menu_click_data_reviews 457 notification_emails: *fxa_app_menu_click_emails 458 expires: never 459 extra_keys: *fxa_app_menu_click_extra 460 telemetry_mirror: Fxa_app_menu_Click_SyncSettings 461 no_lint: 462 - COMMON_PREFIX 463 464 click_sync_tabs: 465 type: event 466 description: > 467 This is recorded on interactions with the FxA menu in the app 468 (hamburger) menu 469 This event was generated to correspond to the Legacy Telemetry event 470 fxa_app_menu.click#sync_tabs. 471 bugs: *fxa_app_menu_click_bugs 472 data_reviews: *fxa_app_menu_click_data_reviews 473 notification_emails: *fxa_app_menu_click_emails 474 expires: never 475 extra_keys: *fxa_app_menu_click_extra 476 telemetry_mirror: Fxa_app_menu_Click_SyncTabs 477 no_lint: 478 - COMMON_PREFIX 479 480 click_sync_tabs_sidebar: 481 type: event 482 description: > 483 This is recorded on interactions with the FxA menu in the app 484 (hamburger) menu 485 This event was generated to correspond to the Legacy Telemetry event 486 fxa_app_menu.click#sync_tabs_sidebar. 487 bugs: *fxa_app_menu_click_bugs 488 data_reviews: *fxa_app_menu_click_data_reviews 489 notification_emails: *fxa_app_menu_click_emails 490 expires: never 491 extra_keys: *fxa_app_menu_click_extra 492 telemetry_mirror: Fxa_app_menu_Click_SyncTabsSidebar 493 no_lint: 494 - COMMON_PREFIX 495 496 click_toolbar_icon: 497 type: event 498 description: > 499 This is recorded on interactions with the FxA menu in the app 500 (hamburger) menu 501 This event was generated to correspond to the Legacy Telemetry event 502 fxa_app_menu.click#toolbar_icon. 503 bugs: *fxa_app_menu_click_bugs 504 data_reviews: *fxa_app_menu_click_data_reviews 505 notification_emails: *fxa_app_menu_click_emails 506 expires: never 507 extra_keys: *fxa_app_menu_click_extra 508 telemetry_mirror: Fxa_app_menu_Click_ToolbarIcon 509 no_lint: 510 - COMMON_PREFIX 511 512 click_unver_sync_settings: 513 type: event 514 description: > 515 This is recorded on interactions with the FxA menu in the app 516 (hamburger) menu 517 This event was generated to correspond to the Legacy Telemetry event 518 fxa_app_menu.click#unver_sync_settings. 519 bugs: *fxa_app_menu_click_bugs 520 data_reviews: *fxa_app_menu_click_data_reviews 521 notification_emails: *fxa_app_menu_click_emails 522 expires: never 523 extra_keys: *fxa_app_menu_click_extra 524 telemetry_mirror: Fxa_app_menu_Click_UnverSyncSettings 525 no_lint: 526 - COMMON_PREFIX 527 528 click_open_monitor: 529 type: event 530 description: > 531 This is recorded on interactions with the FxA menu in the app 532 (hamburger) menu 533 This event was generated to correspond to the Legacy Telemetry event 534 fxa_app_menu.click#open_monitor. 535 bugs: *fxa_app_menu_click_bugs 536 data_reviews: *fxa_app_menu_click_data_reviews 537 notification_emails: *fxa_app_menu_click_emails 538 expires: never 539 extra_keys: *fxa_app_menu_click_extra 540 telemetry_mirror: Fxa_app_menu_Click_OpenMonitor 541 no_lint: 542 - COMMON_PREFIX 543 544 click_open_send: 545 type: event 546 description: > 547 This is recorded on interactions with the FxA menu in the app 548 (hamburger) menu 549 This event was generated to correspond to the Legacy Telemetry event 550 fxa_app_menu.click#open_send. 551 bugs: *fxa_app_menu_click_bugs 552 data_reviews: *fxa_app_menu_click_data_reviews 553 notification_emails: *fxa_app_menu_click_emails 554 expires: never 555 extra_keys: *fxa_app_menu_click_extra 556 telemetry_mirror: Fxa_app_menu_Click_OpenSend 557 no_lint: 558 - COMMON_PREFIX 559 560 click_monitor_cta: 561 type: event 562 description: > 563 This is recorded on interactions with the FxA menu in the app 564 (hamburger) menu 565 This event was generated to correspond to the Legacy Telemetry event 566 fxa_app_menu.click#monitor_cta. 567 bugs: *fxa_app_menu_click_bugs 568 data_reviews: *fxa_app_menu_click_data_reviews 569 notification_emails: *fxa_app_menu_click_emails 570 expires: never 571 extra_keys: *fxa_app_menu_click_extra 572 telemetry_mirror: Fxa_app_menu_Click_MonitorCta 573 no_lint: 574 - COMMON_PREFIX 575 576 click_relay_cta: 577 type: event 578 description: > 579 This is recorded on interactions with the FxA menu in the app 580 (hamburger) menu 581 This event was generated to correspond to the Legacy Telemetry event 582 fxa_app_menu.click#relay_cta. 583 bugs: *fxa_app_menu_click_bugs 584 data_reviews: *fxa_app_menu_click_data_reviews 585 notification_emails: *fxa_app_menu_click_emails 586 expires: never 587 extra_keys: *fxa_app_menu_click_extra 588 telemetry_mirror: Fxa_app_menu_Click_RelayCta 589 no_lint: 590 - COMMON_PREFIX 591 592 click_vpn_cta: 593 type: event 594 description: > 595 This is recorded on interactions with the FxA menu in the app 596 (hamburger) menu 597 This event was generated to correspond to the Legacy Telemetry event 598 fxa_app_menu.click#vpn_cta. 599 bugs: *fxa_app_menu_click_bugs 600 data_reviews: *fxa_app_menu_click_data_reviews 601 notification_emails: *fxa_app_menu_click_emails 602 expires: never 603 extra_keys: *fxa_app_menu_click_extra 604 telemetry_mirror: Fxa_app_menu_Click_VpnCta 605 no_lint: 606 - COMMON_PREFIX 607 608 click_sync_cta: 609 type: event 610 description: > 611 This is recorded on interactions with the FxA menu in the app 612 (hamburger) menu 613 This event was generated to correspond to the Legacy Telemetry event 614 fxa_app_menu.click#sync_cta. 615 bugs: *fxa_app_menu_click_bugs 616 data_reviews: *fxa_app_menu_click_data_reviews 617 notification_emails: *fxa_app_menu_click_emails 618 expires: never 619 extra_keys: *fxa_app_menu_click_extra 620 telemetry_mirror: Fxa_app_menu_Click_SyncCta 621 no_lint: 622 - COMMON_PREFIX 623 624 deletion.request: 625 sync_device_id: 626 type: string 627 description: > 628 An identifier used by sync ping, to identify the current Firefox 629 profile for a specific Account. 630 This metric was generated to correspond to the Legacy Telemetry 631 scalar deletion.request.sync_device_id. 632 bugs: 633 - https://bugzil.la/1604844 634 data_reviews: 635 - https://bugzil.la/1604844 636 notification_emails: 637 - rfkelly@mozilla.com 638 - sync-team@mozilla.com 639 expires: never 640 send_in_pings: ["deletion-request"] 641 telemetry_mirror: DELETION_REQUEST_SYNC_DEVICE_ID 642 643 sync_merge_dialog: 644 clicked: 645 type: event 646 description: > 647 Event to record that showed the user a warning for potentially merging 648 data from multiple accounts and recorded 649 notification_emails: 650 - sync-team@mozilla.com 651 bugs: 652 - https://bugzilla.mozilla.org/1929705/ 653 data_reviews: 654 - https://bugzilla.mozilla.org/1929705/ 655 expires: never 656 extra_keys: 657 option_clicked: 658 description: > 659 Which option the user actually clicked. Which can be "cancel", 660 "continue", "create-profile" or "switch-profile" 661 type: string 662 variant_shown: 663 description: > 664 Which variant we showed the user. Which can be "sync-warning", "sync-warning-allow-merge", 665 "merge-warning", "merge-warning-allow-merge", "old-merge" 666 type: string 667 668 sync: 669 device_count_desktop: 670 type: custom_distribution 671 description: > 672 Number of desktop devices (including this device) associated with this 673 Sync account. Recorded each time Sync successfully completes the 'clients' 674 engine. 675 676 This metric was generated to correspond to the Legacy Telemetry enumerated 677 histogram WEAVE_DEVICE_COUNT_DESKTOP. 678 range_min: 0 679 range_max: 10 680 bucket_count: 11 681 histogram_type: linear 682 bugs: 683 - https://bugzilla.mozilla.org/show_bug.cgi?id=1232050 684 data_reviews: 685 - https://bugzilla.mozilla.org/show_bug.cgi?id=1232050 686 notification_emails: 687 - sync-dev@mozilla.org 688 expires: never 689 telemetry_mirror: WEAVE_DEVICE_COUNT_DESKTOP 690 no_lint: 691 - COMMON_PREFIX 692 693 device_count_mobile: 694 type: custom_distribution 695 description: > 696 Number of mobile devices associated with this Sync account. Recorded each 697 time Sync successfully completes the 'clients' engine. 698 699 This metric was generated to correspond to the Legacy Telemetry enumerated 700 histogram WEAVE_DEVICE_COUNT_MOBILE. 701 range_min: 0 702 range_max: 10 703 bucket_count: 11 704 histogram_type: linear 705 bugs: 706 - https://bugzilla.mozilla.org/show_bug.cgi?id=1232050 707 data_reviews: 708 - https://bugzilla.mozilla.org/show_bug.cgi?id=1232050 709 notification_emails: 710 - sync-dev@mozilla.org 711 expires: never 712 telemetry_mirror: WEAVE_DEVICE_COUNT_MOBILE 713 no_lint: 714 - COMMON_PREFIX 715 716 maintenance_fix_bookmarks: 717 type: event 718 description: | 719 If the last sync failed and we ran maintainenance and this sync succeeded, 720 maintenance likely fixed the issue. 721 bugs: 722 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 723 data_reviews: 724 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 725 data_sensitivity: 726 - technical 727 notification_emails: 728 - sync-dev@mozilla.org 729 expires: never 730 send_in_pings: 731 - sync 732 733 maintenance_run_bookmarks: 734 type: event 735 description: | 736 Bookmark sync failed, and it's been long enough since our last maintenance, 737 so we're running Places maintenance. 738 bugs: 739 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 740 data_reviews: 741 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 742 data_sensitivity: 743 - technical 744 notification_emails: 745 - sync-dev@mozilla.org 746 expires: never 747 send_in_pings: 748 - sync 749 750 sync.client: 751 sendcommand: 752 type: event 753 description: | 754 Records that Sync wrote a remote "command" to another client. 755 These are sync-specific commands for that other client to take some 756 action such as resetting Sync on that client or wiping the local sync 757 data. 758 (It is not used for FxA-specific commands like opening/closing tabs.) 759 bugs: 760 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 761 data_reviews: 762 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 763 data_sensitivity: 764 - technical 765 notification_emails: 766 - sync-dev@mozilla.org 767 expires: never 768 send_in_pings: 769 - sync 770 extra_keys: 771 flow_id: 772 description: | 773 A GUID which uniquely identifies this command invocation. 774 This GUID is the same for every device the command is sent to. 775 type: string 776 reason: 777 description: | 778 Sent when a remote client needs to take some action because of some 779 event which happened on this device, such as restoring bookmarks, 780 which means remote clients need to wipe local bookmarks before syncing 781 the newly restored set. 782 e.g. "bookmark-restore", "wipe-remote" 783 type: string 784 command: 785 description: | 786 The specific command being written. 787 type: string 788 device_id: 789 description: | 790 A GUID which identifies the device the command is being sent to. 791 type: string 792 server_time: &sync_server_time_extra 793 description: | 794 The most recent unix timestamp sent from the sync server via the 795 `X-Weave-Timestamp` HTTP header. 796 Omitted in cases where the client has not yet made a request of the 797 server and whenever else it's unavailable. 798 Included to improve flow analysis across multiple clients. 799 type: string 800 801 processcommand: 802 type: event 803 description: | 804 When the local client has any remote commands and we're processing them. 805 Almost identical to `sync.client.sendcommand` but is recorded by the 806 receiving device rather than the sending device. 807 See `sync.client.sendcommand` for more details. 808 bugs: 809 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 810 data_reviews: 811 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 812 data_sensitivity: 813 - technical 814 notification_emails: 815 - sync-dev@mozilla.org 816 expires: never 817 send_in_pings: 818 - sync 819 extra_keys: 820 flow_id: 821 description: | 822 A GUID which uniquely identifies this command invocation. 823 The value for this GUID will be the same as the `flow_id` sent to the 824 client via `sync.client.sendcommand`. 825 type: string 826 command: 827 description: | 828 The specific command being processed. 829 type: string 830 server_time: *sync_server_time_extra 831 832 syncs: 833 discarded: 834 type: quantity 835 unit: discarded syncs 836 description: | 837 How many syncs happened which were not reported in detail 838 due to being over the number of syncs we report detailed information for. 839 bugs: 840 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 841 data_reviews: 842 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 843 data_sensitivity: 844 - technical 845 notification_emails: 846 - sync-dev@mozilla.org 847 expires: never 848 send_in_pings: 849 - sync 850 851 hashed_fxa_uid: 852 type: string 853 description: | 854 Hashed FxA unique ID, or string of 32 zeroes. 855 If this changes between syncs, the "sync" ping is submitted with reason "idchange". 856 bugs: 857 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 858 data_reviews: 859 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 860 data_sensitivity: 861 - technical 862 notification_emails: 863 - sync-dev@mozilla.org 864 expires: never 865 send_in_pings: 866 - sync 867 868 hashed_device_id: 869 type: string 870 description: | 871 Hashed FxA device ID, hex string of 64 characters. 872 Not included if the user is not logged in. 873 If this changes between syncs, the "sync" ping is submitted with reason "idchange". 874 bugs: 875 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 876 data_reviews: 877 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 878 data_sensitivity: 879 - technical 880 notification_emails: 881 - sync-dev@mozilla.org 882 expires: never 883 send_in_pings: 884 - sync 885 886 session_start_date: 887 type: datetime 888 time_unit: hour 889 description: | 890 When the sync telemetry session begins (the `SyncTelemetryImpl` 891 constructor runs). 892 Typically useful for ordering "sync" pings. 893 bugs: 894 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 895 data_reviews: 896 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 897 data_sensitivity: 898 - technical 899 notification_emails: 900 - sync-dev@mozilla.org 901 expires: never 902 send_in_pings: 903 - sync 904 905 sync_node_type: 906 type: string 907 description: | 908 The "node type" as reported by the token server. 909 This will not change from sync to sync. 910 May not be present if the token server omits this information. 911 bugs: 912 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 913 data_reviews: 914 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 915 data_sensitivity: 916 - technical 917 notification_emails: 918 - sync-dev@mozilla.org 919 expires: never 920 send_in_pings: 921 - sync 922 923 syncs: 924 type: object 925 description: | 926 Recorded syncs. 927 The "sync" ping is not submitted if this is empty. 928 ```text 929 [{ 930 when: integer ms since epoch, 931 took: integer ms duration, 932 didLogin: true if first sync after login, 933 why: 934 - "startup" if first sync after browser startup 935 - "schedule" if it's been too long since the last sync 936 - "score" if one of sync's trackers has a high score value indicating many changes since the last sync 937 - "user" if the user manually triggered the sync 938 - "tabs" if the user opened the synced tabs sidebar, triggering a sync 939 failureReason: { // if there was an error 940 name: {"httperror"|"networkerror"|...}, 941 code: error code for "httperror" and "networkerror" only, 942 error: error string for "othererror" and "unexpectederror" only, 943 from: for "autherror" only, 944 }, 945 devices: [{ // excluded if we couldn't get a valid uid or local device id 946 os: provided by `Services.appinfo.OS`, 947 version: provided by `Services.appinfo.version`, 948 id: hashed FxA device id, 949 device_type: e.g. "mobile", "tv", etc., 950 syncID: hashed sync device id for device, if user is a sync user, 951 (May be different from the FxA device ID) 952 }, ...], 953 status: { 954 sync: value of the Status.sync property, unless we succeeded, 955 service: value of Status.service, unless we succeeded, 956 }, 957 engines: [{ 958 name: Engine name: "bookmarks", "tabs", etc., 959 took: milliseconds (optional), 960 status: value of Status.engines, if not success, 961 incoming: { 962 applied: number of records applied, 963 succeeded: number of records that applied without error, 964 failed: number of records that failed to apply, 965 failedReasons: [{ 966 name: Error message when trying to apply the record, 967 count: How many times this particular error happened, 968 }, ...], 969 }, 970 outgoing: [{ 971 sent: Number of outgoing records sent, 972 failed: Number that failed to send, 973 failedReasons: [{ 974 name: Error message while trying to send the record, 975 count: How many times this particular error happened, 976 }], 977 }, ...], 978 failureReason: { // if there was an error for this specific engine 979 name: {"httperror"|"networkerror"|...}, 980 code: error code for "httperror" and "networkerror" only, 981 error: error string for "othererror" and "unexpectederror" only, 982 from: for "autherror" only, 983 }, 984 steps: [{ // Timings and counts for detailed steps that the bookmarks engine took 985 name: Step name (e.g. "clients", "tabs", "bookmarks-buffered" see `ProgressTracker.STEPS`), 986 took: milliseconds the step took to execute, 987 counts: [{ 988 name: Counter name (e.g. "items", "fetchLocalTree"), 989 count: Counter value, 990 }, ...], 991 }, ...], 992 validation: { // If the engine ran validation on itself. 993 version: integer version, 994 checked: how many records were checked, 995 took: non-monotonic integer duration in millis, 996 problems: [{ 997 name: the problem (e.g. "parentChildDisagreements", "missingChildren"), 998 count: the records with this problem, 999 }, ...] 1000 failureReason: { // if there was an error running validation 1001 name: error name (e.g. "nserror", "unexpectederror"), 1002 code: error code for "httperror" and "networkerror" only, 1003 error: error string for "othererror" and "unexpectederror" only, 1004 from: for "autherror" only, 1005 }, 1006 }, 1007 }, ...] 1008 }, ...] 1009 ``` 1010 bugs: 1011 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 1012 data_reviews: 1013 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 1014 data_sensitivity: 1015 - technical 1016 notification_emails: 1017 - sync-dev@mozilla.org 1018 expires: never 1019 send_in_pings: 1020 - sync 1021 structure: 1022 type: array 1023 items: 1024 type: object 1025 properties: 1026 when: 1027 type: number 1028 took: 1029 type: number 1030 didLogin: 1031 type: boolean 1032 why: 1033 type: string 1034 failureReason: &sync_failure_reason 1035 type: object 1036 properties: 1037 name: 1038 type: string 1039 code: 1040 type: number 1041 error: 1042 type: string 1043 from: 1044 type: string 1045 devices: 1046 type: array 1047 items: 1048 type: object 1049 properties: 1050 os: 1051 type: string 1052 version: 1053 type: string 1054 id: 1055 type: string 1056 device_type: 1057 type: string 1058 syncID: 1059 type: string 1060 status: 1061 type: object 1062 properties: 1063 sync: 1064 type: string 1065 service: 1066 type: string 1067 engines: 1068 type: array 1069 items: 1070 type: object 1071 properties: 1072 name: 1073 type: string 1074 took: 1075 type: number 1076 status: 1077 type: string 1078 incoming: 1079 type: object 1080 properties: 1081 applied: 1082 type: number 1083 succeeded: 1084 type: number 1085 failed: 1086 type: number 1087 failedReasons: &sync_named_counts 1088 type: array 1089 items: 1090 type: object 1091 properties: 1092 name: 1093 type: string 1094 count: 1095 type: number 1096 outgoing: 1097 type: array 1098 items: 1099 type: object 1100 properties: 1101 sent: 1102 type: number 1103 failed: 1104 type: number 1105 failedReasons: *sync_named_counts 1106 failureReason: *sync_failure_reason 1107 steps: 1108 type: array 1109 items: 1110 type: object 1111 properties: 1112 name: 1113 type: string 1114 took: 1115 type: number 1116 counts: *sync_named_counts 1117 validation: 1118 type: object 1119 properties: 1120 checked: 1121 type: number 1122 failureReason: *sync_failure_reason 1123 took: 1124 type: number 1125 version: 1126 type: number 1127 problems: *sync_named_counts 1128 1129 migrations: 1130 type: object 1131 description: | 1132 The application-services developers are in the process of oxidizing parts 1133 of firefox sync and the related data storage code, 1134 which typically requires migrating the old storage into a new database and/or format. 1135 1136 When a migration like this occurs, 1137 a record is reported in this list the next time the sync ping is submitted. 1138 1139 ```text 1140 [{ 1141 migration_type: Presently this is only ever "webext-storage", 1142 entries: The number of entries/preferences in the source (legacy) database, including ones we failed to read, 1143 entriesSuccessful: he number of entries/preferences (see below) which we have successfully migrated into the destination database, 1144 extensions: The number of distinct extensions which have at least one preference in the source (legacy) database, 1145 extensionsSuccessful: The number of distinct extensions which have at least one preference in the destination (migrated) database, 1146 openFailure: A boolean flag that is true if we hit a read error prior to . This likely indicates complete corruption, or a bug in an underlying library like rusqlite, 1147 }] 1148 ``` 1149 1150 **Note: "entries" vs "extensions"** 1151 The `webext-storage` migration record detailed above contains counts for both: 1152 * The number of “entries” detected vs successfully migrated. 1153 * The number of “extensions” detected vs successfully migrated. 1154 1155 This may seem redundant, but these refer to different (but related) things. 1156 The distinction here has to do with the way the two databases store extension-storage data: 1157 * The legacy database stores one row for each 1158 (`extension_id`, `preference_name`, `preference_value`) triple. 1159 These are referred to as `entries`. 1160 * Conversely, the new database stores one row per extension, 1161 which is a pair containing both the `extension_id`, 1162 as well as a dictionary holding all preference data, 1163 and so are equivalent to extensions. 1164 1165 (The description above is a somewhat simplified view of things, 1166 as it ignores a number values each database stores which is irrelevant for migration) 1167 1168 That is, entries represent each individual preference setting, 1169 and extensions represent the collected set of preferences for a given extension. 1170 1171 Counts for are both of these are present as it’s likely that the disparity 1172 would point to different kinds of issues with the migration code. 1173 bugs: 1174 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 1175 data_reviews: 1176 - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812 1177 data_sensitivity: 1178 - technical 1179 notification_emails: 1180 - sync-dev@mozilla.org 1181 expires: never 1182 send_in_pings: 1183 - sync 1184 structure: 1185 type: array 1186 items: 1187 type: object 1188 properties: 1189 migration_type: 1190 type: string 1191 entries: 1192 type: number 1193 entriesSuccessful: 1194 type: number 1195 extensions: 1196 type: number 1197 extensionsSuccessful: 1198 type: number 1199 openFailure: 1200 type: boolean