metrics.yaml (20233B)
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 :: Messaging System' 12 13 messaging_system: 14 event_context_parse_error: 15 type: counter 16 lifetime: ping 17 description: | 18 How often we failed to parse event_context as JSON. 19 bugs: 20 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 21 data_reviews: 22 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 23 data_sensitivity: 24 - technical 25 notification_emails: 26 - dmosedale@mozilla.com 27 - pmcmanis@mozilla.com 28 expires: never 29 send_in_pings: 30 - messaging-system 31 32 event_reason: 33 type: string 34 lifetime: ping 35 description: | 36 The event_context's `reason`. Likely something like 37 "welcome-window-closed" or "app-shut-down",. 38 bugs: 39 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 40 data_reviews: 41 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 42 data_sensitivity: 43 - interaction 44 notification_emails: 45 - dmosedale@mozilla.com 46 - pmcmanis@mozilla.com 47 expires: never 48 send_in_pings: 49 - messaging-system 50 51 event_page: 52 type: string 53 lifetime: ping 54 description: | 55 The event_context's `page`. Almost always "about:welcome". 56 bugs: 57 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 58 data_reviews: 59 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 60 data_sensitivity: 61 - interaction 62 notification_emails: 63 - dmosedale@mozilla.com 64 - pmcmanis@mozilla.com 65 expires: never 66 send_in_pings: 67 - messaging-system 68 69 event_source: 70 type: string 71 lifetime: ping 72 description: | 73 The event_context's `source`. Likely something like "primary_button". 74 bugs: 75 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 76 data_reviews: 77 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 78 data_sensitivity: 79 - interaction 80 notification_emails: 81 - dmosedale@mozilla.com 82 - pmcmanis@mozilla.com 83 expires: never 84 send_in_pings: 85 - messaging-system 86 87 event_context: 88 type: text 89 lifetime: ping 90 description: | 91 The stringified JSON of `event_context`. 92 bugs: 93 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 94 data_reviews: 95 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 96 data_sensitivity: 97 - web_activity 98 notification_emails: 99 - dmosedale@mozilla.com 100 - pmcmanis@mozilla.com 101 expires: never 102 send_in_pings: 103 - messaging-system 104 105 event_screen_family: 106 type: text 107 lifetime: ping 108 description: | 109 A string identifier of the message family derived from the message id 110 (e.g. MR_WELCOME_DEFAULT). 111 bugs: 112 - https://bugzilla.mozilla.org/show_bug.cgi?id=1867627 113 data_reviews: 114 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 115 data_sensitivity: 116 - web_activity 117 notification_emails: 118 - pmcmanis@mozilla.com 119 - dmosedale@mozilla.com 120 - nsauermann@mozilla.com 121 expires: never 122 send_in_pings: 123 - messaging-system 124 125 event_screen_id: 126 type: text 127 lifetime: ping 128 description: | 129 A string identifier of the message screen id 130 (e.g. AW_MOBILE_DOWNLOAD). 131 bugs: 132 - https://bugzilla.mozilla.org/show_bug.cgi?id=1867627 133 data_reviews: 134 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 135 data_sensitivity: 136 - web_activity 137 notification_emails: 138 - pmcmanis@mozilla.com 139 - dmosedale@mozilla.com 140 - nsauermann@mozilla.com 141 expires: never 142 send_in_pings: 143 - messaging-system 144 145 event_screen_initials: 146 type: text 147 lifetime: ping 148 description: | 149 A string identifier of the message screen initials 150 (e.g. 'EMAG' for EASY_SETUP, MOBILE_DOWNLOADS, AMO, GRATITUDE). 151 bugs: 152 - https://bugzilla.mozilla.org/show_bug.cgi?id=1867627 153 data_reviews: 154 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 155 data_sensitivity: 156 - web_activity 157 notification_emails: 158 - pmcmanis@mozilla.com 159 - dmosedale@mozilla.com 160 - nsauermann@mozilla.com 161 expires: never 162 send_in_pings: 163 - messaging-system 164 165 event_screen_index: 166 type: quantity 167 unit: integer 168 lifetime: ping 169 description: | 170 A number identifier of the screen index in a sequence of screens 171 (e.g. 0 for first message). 172 bugs: 173 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 174 data_reviews: 175 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 176 data_sensitivity: 177 - web_activity 178 notification_emails: 179 - pmcmanis@mozilla.com 180 - dmosedale@mozilla.com 181 - nsauermann@mozilla.com 182 expires: never 183 send_in_pings: 184 - messaging-system 185 186 message_id: 187 type: text 188 lifetime: ping 189 description: | 190 A string identifier of the message in Activity Stream Router. 191 bugs: 192 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 193 data_reviews: 194 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 195 data_sensitivity: 196 - web_activity 197 notification_emails: 198 - pmcmanis@mozilla.com 199 - dmosedale@mozilla.com 200 expires: never 201 send_in_pings: 202 - messaging-system 203 204 event: 205 type: string 206 description: > 207 The type of event. Any user defined string 208 (e.g. “IMPRESSION”, “CLICK_BUTTON”, "INDEXEDDB_OPEN_FAILED", “SESSION_END”) 209 bugs: 210 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 211 data_reviews: 212 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 213 data_sensitivity: 214 - interaction 215 notification_emails: 216 - pmcmanis@mozilla.com 217 - dmosedale@mozilla.com 218 expires: never 219 send_in_pings: 220 - messaging-system 221 222 ping_type: 223 type: string 224 description: > 225 Type of event the ping is capturing. 226 e.g. "cfr", "onboarding" 227 bugs: 228 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 229 data_reviews: 230 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 231 data_sensitivity: 232 - interaction 233 notification_emails: 234 - pmcmanis@mozilla.com 235 - dmosedale@mozilla.com 236 expires: never 237 send_in_pings: 238 - messaging-system 239 240 source: 241 type: string 242 description: > 243 The source of the interaction described by the other metrics. 244 e.g. "frecent_links", "newtab", "CFR" 245 bugs: 246 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 247 data_reviews: 248 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 249 data_sensitivity: 250 - interaction 251 notification_emails: 252 - pmcmanis@mozilla.com 253 - dmosedale@mozilla.com 254 expires: never 255 send_in_pings: 256 - messaging-system 257 258 client_id: 259 type: uuid 260 lifetime: ping 261 description: | 262 The client_id according to Telemetry. 263 Might not always have a value due to policy around specific types of 264 ping being sent. Value may be the canary client id 265 `c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0` 266 in pings near when the data upload pref is disabled (if Telemetry gets 267 to go first), or between when a client_id has been removed and when it 268 has been regenerated. 269 Present only in some circumstances (see 270 [bug 1484035]https://bugzilla.mozilla.org/show_bug.cgi?id=1484035)). 271 bugs: 272 - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549 273 - https://bugzilla.mozilla.org/show_bug.cgi?id=1484035 274 data_reviews: 275 - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549 276 data_sensitivity: 277 - technical 278 notification_emails: 279 - dmosedale@mozilla.com 280 - pmcmanis@mozilla.com 281 expires: never 282 send_in_pings: 283 - messaging-system 284 285 locale: 286 type: string 287 lifetime: ping 288 description: > 289 The locale as supplied to the messaging system by 290 `Services.locale.appLocaleAsBCP47`. 291 bugs: 292 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 293 data_reviews: 294 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 295 data_sensitivity: 296 - technical 297 notification_emails: 298 - pmcmanis@mozilla.com 299 - dmosedale@mozilla.com 300 expires: never 301 send_in_pings: 302 - messaging-system 303 304 browser_session_id: 305 type: uuid 306 lifetime: ping 307 # Disable yamllint for long lines. 308 # yamllint disable 309 description: > 310 The Legacy Telemetry browser "session id". 311 Identifies a specific period from application start to shutdown. 312 See [the "main" ping docs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/main-ping.html) 313 for details. 314 # yamllint enable 315 bugs: 316 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 317 data_reviews: 318 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 319 data_sensitivity: 320 - technical 321 notification_emails: 322 - pmcmanis@mozilla.com 323 - dmosedale@mozilla.com 324 expires: never 325 send_in_pings: 326 - messaging-system 327 328 impression_id: 329 type: uuid 330 lifetime: ping 331 description: > 332 The unique impression identifier for a specific client. 333 bugs: 334 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 335 data_reviews: 336 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 337 data_sensitivity: 338 - technical 339 notification_emails: 340 - pmcmanis@mozilla.com 341 - dmosedale@mozilla.com 342 expires: never 343 send_in_pings: 344 - messaging-system 345 346 bucket_id: 347 type: string 348 lifetime: ping 349 description: > 350 A name shared between multiple messages that may individually be too 351 targetted. 352 e.g. a message that gets shown on specific websites or a message asking 353 about personal information. 354 bugs: 355 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 356 data_reviews: 357 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 358 data_sensitivity: 359 - technical 360 notification_emails: 361 - pmcmanis@mozilla.com 362 - dmosedale@mozilla.com 363 expires: never 364 send_in_pings: 365 - messaging-system 366 367 addon_version: 368 type: string 369 lifetime: ping 370 description: > 371 Used to hold the system addon's version, 372 now is almost certainly an echo of the app's build id. 373 bugs: 374 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 375 data_reviews: 376 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 377 data_sensitivity: 378 - technical 379 notification_emails: 380 - pmcmanis@mozilla.com 381 - dmosedale@mozilla.com 382 expires: never 383 send_in_pings: 384 - messaging-system 385 386 unknown_key_count: 387 type: counter 388 description: | 389 The sum of all unknown keys counted. 390 Useful for testing. 391 Can be removed after bug 1600008 is resolved. 392 bugs: 393 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 394 data_reviews: 395 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 396 data_sensitivity: 397 - technical 398 notification_emails: 399 - chutten@mozilla.com 400 expires: never 401 send_in_pings: 402 - messaging-system 403 404 unknown_keys: 405 type: labeled_counter 406 description: | 407 Ping keys supplied to the messaging system for which 408 we did not have a corresponding metric mapped to how often they attempted 409 to be recorded. 410 You may have forgotten to define an appropriate metric in 411 `browser/components/newtab/metrics.yaml`. 412 bugs: 413 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 414 data_reviews: 415 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 416 data_sensitivity: 417 - technical 418 notification_emails: 419 - dmosedale@mozilla.com 420 - pmcmanis@mozilla.com 421 expires: never 422 send_in_pings: 423 - messaging-system 424 425 glean_ping_for_ping_failures: 426 type: counter 427 description: | 428 How often something went awry within 429 `AboutWelcome.submitGleanPingForPing`, preventing ping submission. 430 bugs: 431 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 432 data_reviews: 433 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 434 data_sensitivity: 435 - technical 436 notification_emails: 437 - dmosedale@mozilla.com 438 - pmcmanis@mozilla.com 439 - chutten@mozilla.com 440 expires: never 441 send_in_pings: 442 - metrics 443 444 invalid_nested_data: 445 type: labeled_counter 446 description: | 447 We received a ping with non-scalar data on a field of this name. 448 If this is existing pre-PingCentre-replacement data, you may need to 449 augment the logic in 450 `AboutWelcome.submitGleanPingForPing` like the other `handledKeys`. 451 If this is for new, post-PingCentre-replacement data, you should 452 probably prefer a flat structure. 453 If you're unsure, please ask in 454 [the #glean channel](https://chat.mozilla.org/#/room/#glean:mozilla.org). 455 bugs: 456 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 457 data_reviews: 458 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 459 data_sensitivity: 460 - technical 461 notification_emails: 462 - dmosedale@mozilla.com 463 - pmcmanis@mozilla.com 464 - chutten@mozilla.com 465 expires: never 466 send_in_pings: 467 - messaging-system 468 469 message_request_time: 470 type: timing_distribution 471 description: > 472 Firefox: Time in ms spent selecting and matching messages to user profile. 473 474 This metric was generated to correspond to the Legacy Telemetry 475 exponential histogram MS_MESSAGE_REQUEST_TIME_MS. 476 time_unit: millisecond 477 bugs: 478 - https://bugzilla.mozilla.org/show_bug.cgi?id=1600335 479 data_reviews: 480 - https://bugzilla.mozilla.org/show_bug.cgi?id=1600335 481 notification_emails: 482 - omc-core@mozilla.com 483 - dmosedale@mozilla.com 484 expires: never 485 telemetry_mirror: MS_MESSAGE_REQUEST_TIME_MS 486 487 488 messaging_system.attribution: 489 source: 490 type: string 491 lifetime: ping 492 description: | 493 Attribution's source, possibly derived from the utm parameter of the same 494 name. 495 bugs: 496 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 497 data_reviews: 498 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 499 data_sensitivity: 500 - interaction 501 notification_emails: 502 - dmosedale@mozilla.com 503 - pmcmanis@mozilla.com 504 expires: never 505 send_in_pings: 506 - messaging-system 507 508 medium: 509 type: string 510 lifetime: ping 511 description: | 512 Attribution's medium, possibly derived from the utm parameter of the same 513 name. 514 bugs: 515 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 516 data_reviews: 517 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 518 data_sensitivity: 519 - interaction 520 notification_emails: 521 - dmosedale@mozilla.com 522 - pmcmanis@mozilla.com 523 expires: never 524 send_in_pings: 525 - messaging-system 526 527 campaign: 528 type: string 529 lifetime: ping 530 description: | 531 Attribution's campaign, possibly derived from the utm parameter of the 532 same name. 533 bugs: 534 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 535 data_reviews: 536 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 537 data_sensitivity: 538 - interaction 539 notification_emails: 540 - dmosedale@mozilla.com 541 - pmcmanis@mozilla.com 542 expires: never 543 send_in_pings: 544 - messaging-system 545 546 content: 547 type: string 548 lifetime: ping 549 description: | 550 Attribution's content, possibly derived from the utm parameter of the 551 same name. 552 bugs: 553 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 554 data_reviews: 555 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 556 data_sensitivity: 557 - interaction 558 notification_emails: 559 - dmosedale@mozilla.com 560 - pmcmanis@mozilla.com 561 expires: never 562 send_in_pings: 563 - messaging-system 564 565 experiment: 566 type: string 567 lifetime: ping 568 description: | 569 Attribution's experiment key. 570 bugs: 571 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 572 data_reviews: 573 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 574 data_sensitivity: 575 - interaction 576 notification_emails: 577 - dmosedale@mozilla.com 578 - pmcmanis@mozilla.com 579 expires: never 580 send_in_pings: 581 - messaging-system 582 583 variation: 584 type: string 585 lifetime: ping 586 description: | 587 Attribution's variation key. 588 bugs: 589 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 590 data_reviews: 591 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 592 data_sensitivity: 593 - interaction 594 notification_emails: 595 - dmosedale@mozilla.com 596 - pmcmanis@mozilla.com 597 expires: never 598 send_in_pings: 599 - messaging-system 600 601 ua: 602 type: string 603 lifetime: ping 604 description: | 605 Attribution's ua key. 606 bugs: 607 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 608 data_reviews: 609 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 610 data_sensitivity: 611 - interaction 612 notification_emails: 613 - dmosedale@mozilla.com 614 - pmcmanis@mozilla.com 615 expires: never 616 send_in_pings: 617 - messaging-system 618 619 dltoken: 620 type: string 621 lifetime: ping 622 description: | 623 String representation of the dltoken identifying the particular 624 installer used to install this Firefox. 625 Likely a UUID, if present. 626 bugs: 627 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 628 data_reviews: 629 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 630 data_sensitivity: 631 - interaction 632 notification_emails: 633 - dmosedale@mozilla.com 634 - pmcmanis@mozilla.com 635 expires: never 636 send_in_pings: 637 - messaging-system 638 639 msstoresignedin: 640 type: string 641 lifetime: ping 642 description: | 643 Either the string "true" or the string "false" to indicate whether the 644 attributed install came from the Microsoft store and, if so, whether the 645 user was signed in at the time. 646 bugs: 647 - https://bugzilla.mozilla.org/show_bug.cgi?id=1756209 648 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 649 data_reviews: 650 - https://bugzilla.mozilla.org/show_bug.cgi?id=1756209 651 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 652 data_sensitivity: 653 - interaction 654 notification_emails: 655 - dmosedale@mozilla.com 656 - pmcmanis@mozilla.com 657 expires: never 658 send_in_pings: 659 - messaging-system 660 661 dlsource: 662 type: string 663 lifetime: ping 664 description: | 665 Mozilla-specific download "source" name. Could be something like 666 "mozillaci" to identify that the installer came from 667 `{archive|ftp}.mozilla.org`. 668 bugs: 669 - https://bugzilla.mozilla.org/show_bug.cgi?id=1819997 670 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 671 data_reviews: 672 - https://bugzilla.mozilla.org/show_bug.cgi?id=1819997 673 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 674 data_sensitivity: 675 - interaction 676 notification_emails: 677 - dmosedale@mozilla.com 678 - pmcmanis@mozilla.com 679 expires: never 680 send_in_pings: 681 - messaging-system 682 683 unknown_keys: 684 type: labeled_counter 685 description: | 686 Attribution keys supplied to the messaging system for which 687 we did not have a corresponding metric, and the count of how 688 often that happened. 689 Either add this key to a list of known attribution keys in 690 `AboutWelcomeTelemetry` to suppress or define an appropriate metric in 691 `browser/components/newtab/metrics.yaml` to collect. 692 bugs: 693 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 694 data_reviews: 695 - https://bugzilla.mozilla.org/show_bug.cgi?id=1825863 696 data_sensitivity: 697 - technical 698 notification_emails: 699 - dmosedale@mozilla.com 700 - pmcmanis@mozilla.com 701 expires: never 702 send_in_pings: 703 - messaging-system