metrics.yaml (21393B)
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 :: Migration' 12 13 browser.migration: 14 matched_extensions: 15 type: string_list 16 description: > 17 Records a list of the Chrome extension IDs that were successfully 18 matched to Firefox equivalents from the list downloaded from AMO. 19 bugs: 20 - https://bugzilla.mozilla.org/show_bug.cgi?id=1807023 21 data_reviews: 22 - https://bugzilla.mozilla.org/show_bug.cgi?id=1807023 23 data_sensitivity: 24 - technical 25 notification_emails: 26 - mconley@mozilla.com 27 expires: never 28 29 unmatched_extensions: 30 type: string_list 31 description: > 32 Records a list of the Chrome extension IDs that were unsuccessfully 33 matched to Firefox equivalents from the list downloaded from AMO. 34 bugs: 35 - https://bugzilla.mozilla.org/show_bug.cgi?id=1807023 36 data_reviews: 37 - https://bugzilla.mozilla.org/show_bug.cgi?id=1807023 38 data_sensitivity: 39 - technical 40 notification_emails: 41 - mconley@mozilla.com 42 expires: never 43 44 opened_wizard: 45 type: event 46 description: > 47 Recorded when the migration wizard opens. 48 This event was generated to correspond to the Legacy Telemetry event 49 browser.migration.opened#wizard. 50 bugs: 51 - https://bugzil.la/1824786 52 data_reviews: 53 - https://bugzil.la/1824786 54 notification_emails: 55 - mconley@mozilla.com 56 expires: never 57 telemetry_mirror: BrowserMigration_Opened_Wizard 58 59 no_browsers_found_wizard: 60 type: event 61 description: > 62 Recorded when the migration wizard reports that there are no 63 browsers to migrate from. 64 This event was generated to correspond to the Legacy Telemetry event 65 browser.migration.no_browsers_found#wizard. 66 bugs: 67 - https://bugzil.la/1824786 68 data_reviews: 69 - https://bugzil.la/1824786 70 notification_emails: 71 - mconley@mozilla.com 72 expires: never 73 telemetry_mirror: BrowserMigration_NoBrowsersFound_Wizard 74 75 browser_selected_wizard: 76 type: event 77 description: > 78 Recorded when the user selects a browser to migrate from. 79 This event was generated to correspond to the Legacy Telemetry event 80 browser.migration.browser_selected#wizard. 81 bugs: 82 - https://bugzil.la/1824786 83 data_reviews: 84 - https://bugzil.la/1824786 85 notification_emails: 86 - mconley@mozilla.com 87 expires: never 88 extra_keys: 89 migrator_key: 90 description: > 91 The key of the browser that was selected. 92 type: string 93 telemetry_mirror: BrowserMigration_BrowserSelected_Wizard 94 95 profile_selected_wizard: 96 type: event 97 description: > 98 Recorded when the user selects a profile to migrate from. If the 99 browser doesn't support multiple profiles, this will not be 100 recorded. 101 This event was generated to correspond to the Legacy Telemetry event 102 browser.migration.profile_selected#wizard. 103 bugs: 104 - https://bugzil.la/1824786 105 data_reviews: 106 - https://bugzil.la/1824786 107 notification_emails: 108 - mconley@mozilla.com 109 expires: never 110 extra_keys: 111 migrator_key: 112 description: > 113 The key of the browser that had a profile selected for it. 114 type: string 115 telemetry_mirror: BrowserMigration_ProfileSelected_Wizard 116 117 resources_selected_wizard: 118 type: event 119 description: > 120 Recorded when the user selects resources from the browser / profile 121 to import. 122 This event was generated to correspond to the Legacy Telemetry event 123 browser.migration.resources_selected#wizard. 124 bugs: 125 - https://bugzil.la/1824786 126 data_reviews: 127 - https://bugzil.la/1824786 128 notification_emails: 129 - mconley@mozilla.com 130 expires: never 131 extra_keys: 132 migrator_key: 133 description: > 134 The key of the browser that had resources selected for it. 135 type: string 136 history: 137 description: > 138 "1" if history was selected. "0" otherwise. 139 140 type: string 141 formdata: 142 description: > 143 "1" if form data was selected. "0" otherwise. 144 145 type: string 146 passwords: 147 description: > 148 "1" if passwords was selected. "0" otherwise. 149 150 type: string 151 bookmarks: 152 description: > 153 "1" if bookmarks were selected. "0" otherwise. 154 155 type: string 156 payment_methods: 157 description: > 158 "1" if payment methods were selected. "0" otherwise. 159 160 type: string 161 extensions: 162 description: > 163 "1" if extensions were selected. "0" otherwise. 164 165 type: string 166 other: 167 description: > 168 A count of the number of other resource types that were selected. 169 type: quantity 170 configured: 171 description: > 172 "1" if Variant 2 of the new Migration Wizard was being used, and the list of resources was expanded. "0" otherwise. 173 174 type: string 175 telemetry_mirror: BrowserMigration_ResourcesSelected_Wizard 176 177 linux_perms_wizard: 178 type: event 179 description: > 180 Recorded if the user is on Linux and the browser is installed in a 181 sandboxed environment that prevents it from reading other browser's 182 data, and the user is presented with instructions and an option to 183 grant the browser permission to read that other data. 184 This event was generated to correspond to the Legacy Telemetry event 185 browser.migration.linux_perms#wizard. 186 bugs: 187 - https://bugzil.la/1824786 188 data_reviews: 189 - https://bugzil.la/1824786 190 notification_emails: 191 - mconley@mozilla.com 192 expires: never 193 extra_keys: 194 migrator_key: 195 description: > 196 The key of the migrator that will perform the migration. 197 type: string 198 telemetry_mirror: BrowserMigration_LinuxPerms_Wizard 199 200 safari_perms_wizard: 201 type: event 202 description: > 203 Recorded if the user is on macOS, chose to migrate from Safari, and 204 was presented with the page of the wizard requesting permission to 205 read from the Safari profile folder. 206 This event was generated to correspond to the Legacy Telemetry event 207 browser.migration.safari_perms#wizard. 208 bugs: 209 - https://bugzil.la/1824786 210 data_reviews: 211 - https://bugzil.la/1824786 212 notification_emails: 213 - mconley@mozilla.com 214 expires: never 215 telemetry_mirror: BrowserMigration_SafariPerms_Wizard 216 217 safari_password_file_wizard: 218 type: event 219 description: > 220 Recorded if the user is on macOS, chose to migrate from Safari, and 221 was presented with the page of the wizard requesting to import 222 passwords from a file. This only gets recorded in the new migration 223 wizard. 224 This event was generated to correspond to the Legacy Telemetry event 225 browser.migration.safari_password_file#wizard. 226 bugs: 227 - https://bugzil.la/1824786 228 data_reviews: 229 - https://bugzil.la/1824786 230 notification_emails: 231 - mconley@mozilla.com 232 expires: never 233 telemetry_mirror: BrowserMigration_SafariPasswordFile_Wizard 234 235 chrome_password_file_wizard: 236 type: event 237 description: > 238 Recorded if the user is importing from Chrome, and was presented with 239 the page of the wizard requesting to import passwords from a file. This 240 currently only gets shown on Windows. 241 bugs: 242 - https://bugzil.la/1960560 243 data_reviews: 244 - https://bugzil.la/1960560 245 notification_emails: 246 - mconley@mozilla.com 247 expires: never 248 249 migration_started_wizard: 250 type: event 251 description: > 252 Recorded when the user begins a migration. 253 This event was generated to correspond to the Legacy Telemetry event 254 browser.migration.migration_started#wizard. 255 bugs: 256 - https://bugzil.la/1824786 257 data_reviews: 258 - https://bugzil.la/1824786 259 notification_emails: 260 - mconley@mozilla.com 261 expires: never 262 extra_keys: 263 migrator_key: 264 description: > 265 The key of the migrator that will perform the migration. 266 type: string 267 history: 268 description: > 269 "1" if history is being migrated. "0" otherwise. 270 271 type: string 272 formdata: 273 description: > 274 "1" if form data is being migrated. "0" otherwise. 275 276 type: string 277 passwords: 278 description: > 279 "1" if passwords are being migrated. "0" otherwise. 280 281 type: string 282 bookmarks: 283 description: > 284 "1" if bookmarks are being migrated. "0" otherwise. 285 286 type: string 287 payment_methods: 288 description: > 289 "1" if payment methods are being migrated. "0" otherwise. 290 291 type: string 292 extensions: 293 description: > 294 "1" if extensions are being migrated. "0" otherwise. 295 296 type: string 297 other: 298 description: > 299 A count of the number of other resource types that are being migrated. 300 type: quantity 301 telemetry_mirror: BrowserMigration_MigrationStarted_Wizard 302 303 migration_finished_wizard: 304 type: event 305 description: > 306 Recorded when the user finishes a migration. 307 This event was generated to correspond to the Legacy Telemetry event 308 browser.migration.migration_finished#wizard. 309 bugs: 310 - https://bugzil.la/1824786 311 data_reviews: 312 - https://bugzil.la/1824786 313 notification_emails: 314 - mconley@mozilla.com 315 expires: never 316 extra_keys: 317 migrator_key: 318 description: > 319 The key of the migrator that will perform the migration. 320 type: string 321 history: 322 description: > 323 "1" if history was migrated. "0" otherwise. 324 325 type: string 326 formdata: 327 description: > 328 "1" if form data was migrated. "0" otherwise. 329 330 type: string 331 passwords: 332 description: > 333 "1" if passwords were migrated. "0" otherwise. 334 335 type: string 336 bookmarks: 337 description: > 338 "1" if bookmarks were migrated. "0" otherwise. 339 340 type: string 341 payment_methods: 342 description: > 343 "1" if payment methods were migrated. "0" otherwise. 344 345 type: string 346 extensions: 347 description: > 348 "1" if no extensions were matched, "2" if only some extensions were matched, "3" if all extensions were matched, and "0" if extensions weren't selected for migration. 349 350 type: string 351 other: 352 description: > 353 A count of the number of other resource types that were migrated. 354 type: quantity 355 telemetry_mirror: BrowserMigration_MigrationFinished_Wizard 356 357 entry_point_categorical: 358 type: labeled_counter 359 description: > 360 Where the migration wizard was entered from. 361 362 This metric was generated to correspond to the Legacy Telemetry 363 categorical histogram FX_MIGRATION_ENTRY_POINT_CATEGORICAL. 364 labels: 365 - unknown 366 - firstrun 367 - fxrefresh 368 - places 369 - passwords 370 - newtab 371 - file_menu 372 - help_menu 373 - bookmarks_toolbar 374 - preferences 375 bugs: 376 - https://bugzilla.mozilla.org/show_bug.cgi?id=1822692 377 data_reviews: 378 - https://bugzilla.mozilla.org/show_bug.cgi?id=1822692 379 notification_emails: 380 - mconley@mozilla.com 381 - gijs@mozilla.com 382 - mak@mozilla.com 383 expires: never 384 telemetry_mirror: h#FX_MIGRATION_ENTRY_POINT_CATEGORICAL 385 386 source_browser: 387 type: custom_distribution 388 description: > 389 The browser that data is pulled from. The values correspond to the 390 internal browser ID (see MigrationUtils.sys.mjs) 391 392 This metric was generated to correspond to the Legacy Telemetry enumerated 393 histogram FX_MIGRATION_SOURCE_BROWSER. 394 range_min: 0 395 range_max: 15 396 bucket_count: 16 397 histogram_type: linear 398 bugs: 399 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 400 - https://bugzilla.mozilla.org/show_bug.cgi?id=1523179 401 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 402 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 403 data_reviews: 404 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 405 - https://bugzilla.mozilla.org/show_bug.cgi?id=1523179 406 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 407 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 408 notification_emails: 409 - gijs@mozilla.com 410 - mak@mozilla.com 411 expires: never 412 telemetry_mirror: FX_MIGRATION_SOURCE_BROWSER 413 414 errors: 415 type: labeled_custom_distribution 416 description: > 417 Errors encountered during migration in buckets defined by the datatype, 418 keyed by the string description of the browser. 419 420 This metric was generated to correspond to the Legacy Telemetry enumerated 421 histogram FX_MIGRATION_ERRORS. 422 range_min: 0 423 range_max: 12 424 bucket_count: 13 425 histogram_type: linear 426 bugs: 427 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 428 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 429 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 430 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 431 data_reviews: 432 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 433 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 434 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 435 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 436 notification_emails: 437 - gijs@mozilla.com 438 - mak@mozilla.com 439 expires: never 440 telemetry_mirror: FX_MIGRATION_ERRORS 441 442 usage: 443 type: labeled_custom_distribution 444 description: > 445 Usage of migration for each datatype when migration is run through the 446 post-firstrun flow which allows individual datatypes, keyed by the string 447 description of the browser. 448 449 This metric was generated to correspond to the Legacy Telemetry enumerated 450 histogram FX_MIGRATION_USAGE. 451 range_min: 0 452 range_max: 12 453 bucket_count: 13 454 histogram_type: linear 455 bugs: 456 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 457 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 458 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 459 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 460 data_reviews: 461 - https://bugzilla.mozilla.org/show_bug.cgi?id=731025 462 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 463 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 464 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 465 notification_emails: 466 - gijs@mozilla.com 467 - mak@mozilla.com 468 expires: never 469 telemetry_mirror: FX_MIGRATION_USAGE 470 471 bookmarks_quantity: 472 type: labeled_custom_distribution 473 description: > 474 How many bookmarks we imported from another browser, keyed by the name of 475 the browser. 476 477 This metric was generated to correspond to the Legacy Telemetry 478 exponential histogram FX_MIGRATION_BOOKMARKS_QUANTITY. 479 range_min: 1 480 range_max: 1000 481 bucket_count: 20 482 histogram_type: exponential 483 unit: bookmarks 484 bugs: 485 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 486 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 487 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 488 data_reviews: 489 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 490 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 491 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 492 notification_emails: 493 - gijs@mozilla.com 494 - mak@mozilla.com 495 expires: never 496 telemetry_mirror: FX_MIGRATION_BOOKMARKS_QUANTITY 497 498 history_quantity: 499 type: labeled_custom_distribution 500 description: > 501 How many history visits we imported from another browser, keyed by the 502 name of the browser. 503 504 This metric was generated to correspond to the Legacy Telemetry 505 exponential histogram FX_MIGRATION_HISTORY_QUANTITY. 506 range_min: 1 507 range_max: 10000 508 bucket_count: 40 509 histogram_type: exponential 510 unit: history visits 511 bugs: 512 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 513 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 514 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 515 data_reviews: 516 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 517 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 518 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 519 notification_emails: 520 - gijs@mozilla.com 521 - mak@mozilla.com 522 expires: never 523 telemetry_mirror: FX_MIGRATION_HISTORY_QUANTITY 524 525 logins_quantity: 526 type: labeled_custom_distribution 527 description: > 528 How many logins (passwords) we imported from another browser, keyed by the 529 name of the browser. 530 531 This metric was generated to correspond to the Legacy Telemetry 532 exponential histogram FX_MIGRATION_LOGINS_QUANTITY. 533 range_min: 1 534 range_max: 1000 535 bucket_count: 20 536 histogram_type: exponential 537 unit: passwords 538 bugs: 539 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 540 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 541 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 542 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 543 data_reviews: 544 - https://bugzilla.mozilla.org/show_bug.cgi?id=1279501 545 - https://bugzilla.mozilla.org/show_bug.cgi?id=1584261 546 - https://bugzilla.mozilla.org/show_bug.cgi?id=1643431 547 - https://bugzilla.mozilla.org/show_bug.cgi?id=1678204 548 notification_emails: 549 - gijs@mozilla.com 550 - mak@mozilla.com 551 - passwords-dev@mozilla.org 552 expires: never 553 telemetry_mirror: FX_MIGRATION_LOGINS_QUANTITY 554 555 cards_quantity: 556 type: labeled_custom_distribution 557 description: > 558 How many credit card entries we imported from another browser, keyed by 559 the name of the browser. 560 561 This metric was generated to correspond to the Legacy Telemetry 562 exponential histogram FX_MIGRATION_CARDS_QUANTITY. 563 range_min: 1 564 range_max: 1000 565 bucket_count: 20 566 histogram_type: exponential 567 unit: credit card entries 568 bugs: 569 - https://bugzilla.mozilla.org/show_bug.cgi?id=1834545 570 data_reviews: 571 - https://bugzilla.mozilla.org/show_bug.cgi?id=1834545 572 notification_emails: 573 - mconley@mozilla.com 574 expires: never 575 telemetry_mirror: FX_MIGRATION_CARDS_QUANTITY 576 577 extensions_quantity: 578 type: labeled_custom_distribution 579 description: > 580 How many extensions were matched to be imported from another browser, 581 keyed by the name of the browser. 582 583 This metric was generated to correspond to the Legacy Telemetry 584 exponential histogram FX_MIGRATION_EXTENSIONS_QUANTITY. 585 range_min: 1 586 range_max: 1000 587 bucket_count: 20 588 histogram_type: exponential 589 unit: extensions 590 bugs: 591 - https://bugzilla.mozilla.org/show_bug.cgi?id=1834545 592 data_reviews: 593 - https://bugzilla.mozilla.org/show_bug.cgi?id=1834545 594 notification_emails: 595 - mconley@mozilla.com 596 expires: never 597 telemetry_mirror: FX_MIGRATION_EXTENSIONS_QUANTITY 598 599 migration: 600 uninstaller_profile_refresh: 601 type: boolean 602 description: > 603 Set when a profile refresh is initiated from the uninstaller. 604 This metric was generated to correspond to the Legacy Telemetry 605 scalar migration.uninstaller_profile_refresh. 606 bugs: 607 - https://bugzil.la/1634115 608 - https://bugzil.la/1672585 609 data_reviews: 610 - https://bugzil.la/1634115 611 - https://bugzil.la/1672585 612 notification_emails: 613 - application-update-telemetry-alerts@mozilla.com 614 expires: never 615 telemetry_mirror: MIGRATION_UNINSTALLER_PROFILE_REFRESH 616 617 discovered_migrators: 618 type: labeled_counter 619 description: > 620 A keyed uint recording how many times the migration wizard detected 621 a browser / profile pair for a particular browser. This is 622 incremented every time the discovery occurs, so multiple openings of 623 the wizard will increase the counts each time. 624 This metric was generated to correspond to the Legacy Telemetry 625 scalar migration.discovered_migrators. 626 bugs: 627 - https://bugzil.la/1825655 628 data_reviews: 629 - https://bugzil.la/1825655 630 notification_emails: 631 - mconley@mozilla.com 632 expires: never 633 telemetry_mirror: MIGRATION_DISCOVERED_MIGRATORS 634 635 time_to_produce_migrator_list: 636 type: timespan 637 description: > 638 The amount of time it took in milliseconds to produce the list of 639 migrators and profiles for the first time the migration wizard 640 opened during the process lifetime. 641 This metric was generated to correspond to the Legacy Telemetry 642 scalar migration.time_to_produce_migrator_list. 643 bugs: 644 - https://bugzil.la/1840917 645 data_reviews: 646 - https://bugzil.la/1840917 647 notification_emails: 648 - mconley@mozilla.com 649 expires: never 650 time_unit: millisecond 651 telemetry_mirror: MIGRATION_TIME_TO_PRODUCE_MIGRATOR_LIST