metrics.yaml (17166B)
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 - 'Toolkit :: Startup and Profile System' 12 13 profiles.default: 14 updated: 15 type: event 16 description: > 17 Recorded when a new profile from a profile group becomes the default 18 startup profile for the group. This may happen when a profile other 19 than the current default is launched from the profile selector window, 20 or when the user has multiple profiles running at the same time and 21 switches app focus to a profile other than the current default. An 22 event is not recorded if the current default profile is launched or 23 gains app focus. 24 bugs: 25 - https://bugzilla.mozilla.org/show_bug.cgi?id=1918813 26 data_reviews: 27 - https://bugzilla.mozilla.org/show_bug.cgi?id=1918813 28 notification_emails: 29 - cmkm@mozilla.com 30 - dtownsend@mozilla.com 31 - jhirsch@mozilla.com 32 - nbaumgardner@mozilla.com 33 expires: never 34 send_in_pings: ['events', 'profiles'] 35 telemetry_mirror: Profiles_Default_Updated 36 37 profiles.delete: 38 cancel: 39 type: event 40 description: > 41 Recorded when the user clicks the "Cancel" button on the 42 about:deleteprofile page, canceling deletion of the current profile 43 and closing the page. 44 bugs: 45 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 46 data_reviews: 47 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 48 notification_emails: 49 - cmkm@mozilla.com 50 - dtownsend@mozilla.com 51 - jhirsch@mozilla.com 52 - nbaumgardner@mozilla.com 53 expires: never 54 send_in_pings: ['events', 'profiles'] 55 telemetry_mirror: Profiles_Delete_Cancel 56 confirm: 57 type: event 58 description: > 59 Recorded when the user clicks the "Delete" button on the 60 about:deleteprofile page, triggering deletion of the current profile. 61 bugs: 62 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 63 data_reviews: 64 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 65 notification_emails: 66 - cmkm@mozilla.com 67 - dtownsend@mozilla.com 68 - jhirsch@mozilla.com 69 - nbaumgardner@mozilla.com 70 expires: never 71 send_in_pings: ['events', 'profiles'] 72 telemetry_mirror: Profiles_Delete_Confirm 73 displayed: 74 type: event 75 description: Recorded when the about:deleteprofile page is loaded. 76 bugs: 77 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 78 data_reviews: 79 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927608 80 notification_emails: 81 - cmkm@mozilla.com 82 - dtownsend@mozilla.com 83 - jhirsch@mozilla.com 84 - nbaumgardner@mozilla.com 85 expires: never 86 send_in_pings: ['events', 'profiles'] 87 telemetry_mirror: Profiles_Delete_Displayed 88 89 profiles.existing: 90 alert: 91 type: event 92 description: > 93 Recorded when the user tries to close the about:editprofile page without 94 setting a name. A beforeunload alert is then displayed. We record the 95 user's decision to stay on the page or leave in the `extra` value. 96 extra_keys: 97 value: 98 description: 99 The `value` of the event. Mirrors to the Legacy Telemetry 100 event's `value` parameter. The `value` is `leave` if the user chose 101 to leave the page, and `cancel` if the user chose to stay on the 102 page. 103 type: string 104 bugs: 105 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 106 data_reviews: 107 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 108 notification_emails: 109 - cmkm@mozilla.com 110 - dtownsend@mozilla.com 111 - jhirsch@mozilla.com 112 - nbaumgardner@mozilla.com 113 expires: never 114 send_in_pings: ['events', 'profiles'] 115 telemetry_mirror: Profiles_Existing_Alert 116 avatar: 117 type: event 118 description: Recorded when the user selects a different avatar. 119 extra_keys: 120 value: 121 description: > 122 The `value` of the event. Mirrors to the Legacy Telemetry 123 event's `value` parameter. The `value` is the name of the avatar. 124 type: string 125 bugs: 126 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 127 data_reviews: 128 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 129 notification_emails: 130 - cmkm@mozilla.com 131 - dtownsend@mozilla.com 132 - jhirsch@mozilla.com 133 - nbaumgardner@mozilla.com 134 expires: never 135 send_in_pings: ['events', 'profiles'] 136 telemetry_mirror: Profiles_Existing_Avatar 137 closed: 138 type: event 139 description: Recorded when the page is closed. 140 extra_keys: 141 value: 142 description: > 143 The `value` of the event. Mirrors to the Legacy Telemetry 144 event's `value` parameter. If the user clicked the "Done Editing" 145 button, the `value` will be `done_editing`. Otherwise, the user 146 navigated away or closed the tab, and the `value` will be `pagehide`. 147 type: string 148 bugs: 149 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 150 data_reviews: 151 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 152 notification_emails: 153 - cmkm@mozilla.com 154 - dtownsend@mozilla.com 155 - jhirsch@mozilla.com 156 - nbaumgardner@mozilla.com 157 expires: never 158 send_in_pings: ['events', 'profiles'] 159 telemetry_mirror: Profiles_Existing_Closed 160 deleted: 161 type: event 162 description: Recorded when the user clicks the delete button. 163 bugs: 164 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 165 data_reviews: 166 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 167 notification_emails: 168 - cmkm@mozilla.com 169 - dtownsend@mozilla.com 170 - jhirsch@mozilla.com 171 - nbaumgardner@mozilla.com 172 expires: never 173 send_in_pings: ['events', 'profiles'] 174 telemetry_mirror: Profiles_Existing_Deleted 175 displayed: 176 type: event 177 description: Recorded when the page is loaded. 178 bugs: 179 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 180 data_reviews: 181 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 182 notification_emails: 183 - cmkm@mozilla.com 184 - dtownsend@mozilla.com 185 - jhirsch@mozilla.com 186 - nbaumgardner@mozilla.com 187 expires: never 188 send_in_pings: ['events', 'profiles'] 189 telemetry_mirror: Profiles_Existing_Displayed 190 learn_more: 191 type: event 192 description: Recorded when the "explore more addons" link is clicked. 193 bugs: 194 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 195 data_reviews: 196 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 197 notification_emails: 198 - cmkm@mozilla.com 199 - dtownsend@mozilla.com 200 - jhirsch@mozilla.com 201 - nbaumgardner@mozilla.com 202 expires: never 203 send_in_pings: ['events', 'profiles'] 204 telemetry_mirror: Profiles_Existing_LearnMore 205 name: 206 type: event 207 description: > 208 Recorded when the name is changed. This event is fired either after the 209 user has stopped typing in the name input field for 2 seconds, or if 210 they have edited the name, then quickly closed the tab. 211 bugs: 212 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 213 data_reviews: 214 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 215 notification_emails: 216 - cmkm@mozilla.com 217 - dtownsend@mozilla.com 218 - jhirsch@mozilla.com 219 - nbaumgardner@mozilla.com 220 expires: never 221 send_in_pings: ['events', 'profiles'] 222 telemetry_mirror: Profiles_Existing_Name 223 shortcut: 224 type: event 225 description: Recorded when the user clicks the desktop shortcut toggle. 226 extra_keys: 227 value: 228 description: > 229 The `value` of the event. Mirrors to the Legacy Telemetry 230 event's `value` parameter. If the user changed the toggle to the 231 "on" position, the `value` will be `create`. If the user changed 232 the toggle to the "off" position, the `value` will be `delete`. 233 type: string 234 bugs: 235 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997471 236 data_reviews: 237 - https://bugzilla.mozilla.org/show_bug.cgi?id=1997471 238 notification_emails: 239 - cmkm@mozilla.com 240 - dtownsend@mozilla.com 241 - jhirsch@mozilla.com 242 - nbaumgardner@mozilla.com 243 expires: never 244 send_in_pings: ['events', 'profiles'] 245 telemetry_mirror: Profiles_Existing_Shortcut 246 theme: 247 type: event 248 description: Recorded when the user selects a different theme. 249 extra_keys: 250 value: 251 description: > 252 The `value` of the event (name of the theme). Mirrors to the Legacy 253 Telemetry event's `value` parameter. The `value` is the ID of the 254 theme, which may be the ID of a built-in theme or a third-party 255 theme. The map of IDs to profile names must be added elsewhere. 256 type: string 257 bugs: 258 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 259 data_reviews: 260 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927607 261 notification_emails: 262 - cmkm@mozilla.com 263 - dtownsend@mozilla.com 264 - jhirsch@mozilla.com 265 - nbaumgardner@mozilla.com 266 expires: never 267 send_in_pings: ['events', 'profiles'] 268 telemetry_mirror: Profiles_Existing_Theme 269 270 profiles.new: 271 alert: 272 type: event 273 description: > 274 Recorded when the user tries to close the about:newprofile page without 275 setting a name. A beforeunload alert is then displayed. We record the 276 user's decision to stay on the page or leave in the `extra` value. 277 extra_keys: 278 value: 279 description: > 280 The `value` of the event. Mirrors to the Legacy Telemetry 281 event's `value` parameter. The `value` is `leave` if the user chose 282 to leave the page, and `cancel` if the user chose to stay on the 283 page. 284 type: string 285 bugs: 286 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 287 data_reviews: 288 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 289 notification_emails: 290 - cmkm@mozilla.com 291 - dtownsend@mozilla.com 292 - jhirsch@mozilla.com 293 - nbaumgardner@mozilla.com 294 expires: never 295 send_in_pings: ['events', 'profiles'] 296 telemetry_mirror: Profiles_New_Alert 297 avatar: 298 type: event 299 description: Recorded when the user selects a different avatar. 300 extra_keys: 301 value: 302 description: > 303 The `value` of the event. Mirrors to the Legacy Telemetry 304 event's `value` parameter. The `value` is the name of the avatar. 305 type: string 306 bugs: 307 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 308 data_reviews: 309 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 310 notification_emails: 311 - cmkm@mozilla.com 312 - dtownsend@mozilla.com 313 - jhirsch@mozilla.com 314 - nbaumgardner@mozilla.com 315 expires: never 316 send_in_pings: ['events', 'profiles'] 317 telemetry_mirror: Profiles_New_Avatar 318 closed: 319 type: event 320 description: Recorded when the page is closed. 321 extra_keys: 322 value: 323 description: > 324 The `value` of the event. Mirrors to the Legacy Telemetry 325 event's `value` parameter. If the user clicked the "Done Editing" 326 button, the `value` will be `done_editing`. Otherwise, the user 327 navigated away or closed the tab, and the `value` will be `pagehide`. 328 type: string 329 bugs: 330 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 331 data_reviews: 332 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 333 notification_emails: 334 - cmkm@mozilla.com 335 - dtownsend@mozilla.com 336 - jhirsch@mozilla.com 337 - nbaumgardner@mozilla.com 338 expires: never 339 send_in_pings: ['events', 'profiles'] 340 telemetry_mirror: Profiles_New_Closed 341 deleted: 342 type: event 343 description: Recorded when the user clicks the delete button. 344 bugs: 345 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 346 data_reviews: 347 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 348 notification_emails: 349 - cmkm@mozilla.com 350 - dtownsend@mozilla.com 351 - jhirsch@mozilla.com 352 - nbaumgardner@mozilla.com 353 expires: never 354 send_in_pings: ['events', 'profiles'] 355 telemetry_mirror: Profiles_New_Deleted 356 displayed: 357 type: event 358 description: Recorded when the page is loaded. 359 bugs: 360 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 361 data_reviews: 362 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 363 notification_emails: 364 - cmkm@mozilla.com 365 - dtownsend@mozilla.com 366 - jhirsch@mozilla.com 367 - nbaumgardner@mozilla.com 368 expires: never 369 send_in_pings: ['events', 'profiles'] 370 telemetry_mirror: Profiles_New_Displayed 371 learn_more: 372 type: event 373 description: Recorded when the "explore more addons" link is clicked. 374 bugs: 375 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 376 data_reviews: 377 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 378 notification_emails: 379 - cmkm@mozilla.com 380 - dtownsend@mozilla.com 381 - jhirsch@mozilla.com 382 - nbaumgardner@mozilla.com 383 expires: never 384 send_in_pings: ['events', 'profiles'] 385 telemetry_mirror: Profiles_New_LearnMore 386 name: 387 type: event 388 description: > 389 Recorded when the name is changed. This event is fired either after the 390 user has stopped typing in the name input field for 2 seconds, or if 391 they have edited the name, then quickly closed the tab. 392 bugs: 393 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 394 data_reviews: 395 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 396 notification_emails: 397 - cmkm@mozilla.com 398 - dtownsend@mozilla.com 399 - jhirsch@mozilla.com 400 - nbaumgardner@mozilla.com 401 expires: never 402 send_in_pings: ['events', 'profiles'] 403 telemetry_mirror: Profiles_New_Name 404 theme: 405 type: event 406 description: Recorded when the user selects a different theme. 407 extra_keys: 408 value: 409 description: > 410 The `value` of the event (name of the theme). Mirrors to the Legacy 411 Telemetry event's `value` parameter. The `value` is the ID of the 412 theme, which may be the ID of a built-in theme or a third-party 413 theme. The map of IDs to profile names must be added elsewhere. 414 type: string 415 bugs: 416 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 417 data_reviews: 418 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941698 419 notification_emails: 420 - cmkm@mozilla.com 421 - dtownsend@mozilla.com 422 - jhirsch@mozilla.com 423 - nbaumgardner@mozilla.com 424 expires: never 425 send_in_pings: ['events', 'profiles'] 426 telemetry_mirror: Profiles_New_Theme 427 428 profiles.selector_window: 429 launch: 430 type: event 431 description: > 432 Recorded when the user clicks a profile card in the profile selector 433 window, launching the profile in a new Firefox instance. 434 bugs: 435 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927605 436 data_reviews: 437 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927605 438 notification_emails: 439 - cmkm@mozilla.com 440 - dtownsend@mozilla.com 441 - jhirsch@mozilla.com 442 - nbaumgardner@mozilla.com 443 expires: never 444 send_in_pings: ['events', 'profiles'] 445 telemetry_mirror: Profiles_SelectorWindow_Launch 446 show_at_startup: 447 type: event 448 description: > 449 Recorded when the user toggles the checkbox that determines if the 450 profile selector window is shown at startup. 451 extra_keys: 452 value: 453 description: > 454 The `value` of the event. Mirrors to the Legacy Telemetry 455 event's `value` parameter. If the user checked the checkbox, the 456 `value` will be `enabled`. If the user unchecked the checkbox, 457 the `value` will be `disabled`. 458 type: string 459 bugs: 460 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927605 461 data_reviews: 462 - https://bugzilla.mozilla.org/show_bug.cgi?id=1927605 463 notification_emails: 464 - cmkm@mozilla.com 465 - dtownsend@mozilla.com 466 - jhirsch@mozilla.com 467 - nbaumgardner@mozilla.com 468 expires: never 469 send_in_pings: ['events', 'profiles'] 470 telemetry_mirror: Profiles_SelectorWindow_ShowAtStartup 471 472 profile.lock: 473 failed_lock_count: 474 type: quantity 475 unit: lock attempts 476 description: | 477 The number of failed profile lock attempts that occurred prior to 478 successfully locking the profile and starting the app. 479 Previously collected in the "main" ping's `simpleMeasurements`. 480 bugs: 481 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 482 data_reviews: 483 - https://bugzilla.mozilla.org/show_bug.cgi?id=1972836 484 expires: never 485 data_sensitivity: 486 - interaction 487 notification_emails: 488 - dtownsend@mozilla.com 489 - jhirsch@mozilla.com