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/.
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
9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
11 - 'Firefox :: Normandy Client'
14 enroll_preference_study:
17 Sent when applying a Normandy recipe of the above types has
19 This event was generated to correspond to the Legacy Telemetry event
20 normandy.enroll#preference_study.
21 bugs: &normandy_enroll_bugs
22 - https://bugzil.la/1443560
23 data_reviews: &normandy_enroll_data_reviews
24 - https://bugzil.la/1443560
25 notification_emails: &normandy_enroll_emails
26 - normandy-notifications@mozilla.com
28 extra_keys: &normandy_enroll_extra
31 The `value` of the event. Mirrors to the Legacy Telemetry
32 event's `value` parameter.
36 For preference_study and nimbus_experiment recipes, the type of experiment this is ("exp" or "exp-highpop").
41 The slug of the branch that was chosen for this client.
46 For addon_study recipes, the ID of the addon that was installed.
50 For addon_study recipes, the version of the addon that was installed.
52 telemetry_mirror: Normandy_Enroll_PreferenceStudy
57 Sent when applying a Normandy recipe of the above types has
59 This event was generated to correspond to the Legacy Telemetry event
60 normandy.enroll#addon_study.
61 bugs: *normandy_enroll_bugs
62 data_reviews: *normandy_enroll_data_reviews
63 notification_emails: *normandy_enroll_emails
65 extra_keys: *normandy_enroll_extra
66 telemetry_mirror: Normandy_Enroll_AddonStudy
68 enroll_preference_rollout:
71 Sent when applying a Normandy recipe of the above types has
73 This event was generated to correspond to the Legacy Telemetry event
74 normandy.enroll#preference_rollout.
75 bugs: *normandy_enroll_bugs
76 data_reviews: *normandy_enroll_data_reviews
77 notification_emails: *normandy_enroll_emails
79 extra_keys: *normandy_enroll_extra
80 telemetry_mirror: Normandy_Enroll_PreferenceRollout
85 Sent when applying a Normandy recipe of the above types has
87 This event was generated to correspond to the Legacy Telemetry event
88 normandy.enroll#addon_rollout.
89 bugs: *normandy_enroll_bugs
90 data_reviews: *normandy_enroll_data_reviews
91 notification_emails: *normandy_enroll_emails
93 extra_keys: *normandy_enroll_extra
94 telemetry_mirror: Normandy_Enroll_AddonRollout
96 enroll_nimbus_experiment:
99 Sent when applying a Normandy recipe of the above types has
101 This event was generated to correspond to the Legacy Telemetry event
102 normandy.enroll#nimbus_experiment.
103 bugs: *normandy_enroll_bugs
104 data_reviews: *normandy_enroll_data_reviews
105 notification_emails: *normandy_enroll_emails
107 extra_keys: *normandy_enroll_extra
108 telemetry_mirror: Normandy_Enroll_NimbusExperiment
110 enroll_failed_addon_study:
113 Sent when applying a Normandy recipe of the above types has failed.
114 This event was generated to correspond to the Legacy Telemetry event
115 normandy.enrollFailed#addon_study.
116 bugs: &normandy_enrollFailed_bugs
117 - https://bugzil.la/1443560
118 data_reviews: &normandy_enrollFailed_data_reviews
119 - https://bugzil.la/1443560
120 notification_emails: &normandy_enrollFailed_emails
121 - normandy-notifications@mozilla.com
123 extra_keys: &normandy_enrollFailed_extra
126 The `value` of the event. Mirrors to the Legacy Telemetry
127 event's `value` parameter.
131 An error code describing the failure.
135 For preference_rollout when reason=conflict, the name of the preference that was going to be modified.
140 For addon_study and branched_addon study, extra text describing the failure.
145 The branch that failed to enroll.
150 The ID of the addon for the rollout when reason=conflict.
154 The slug for the conflicting rollout.
158 The enrollment ID of the conflicting rollout.
162 For preference_study when reason=invalid-branch, the branch that was invalid.
164 telemetry_mirror: Normandy_Enrollfailed_AddonStudy
166 enroll_failed_preference_rollout:
169 Sent when applying a Normandy recipe of the above types has failed.
170 This event was generated to correspond to the Legacy Telemetry event
171 normandy.enrollFailed#preference_rollout.
172 bugs: *normandy_enrollFailed_bugs
173 data_reviews: *normandy_enrollFailed_data_reviews
174 notification_emails: *normandy_enrollFailed_emails
176 extra_keys: *normandy_enrollFailed_extra
177 telemetry_mirror: Normandy_Enrollfailed_PreferenceRollout
179 enroll_failed_preference_study:
182 Sent when applying a Normandy recipe of the above types has failed.
183 This event was generated to correspond to the Legacy Telemetry event
184 normandy.enrollFailed#preference_study.
185 bugs: *normandy_enrollFailed_bugs
186 data_reviews: *normandy_enrollFailed_data_reviews
187 notification_emails: *normandy_enrollFailed_emails
189 extra_keys: *normandy_enrollFailed_extra
190 telemetry_mirror: Normandy_Enrollfailed_PreferenceStudy
192 enroll_failed_addon_rollout:
195 Sent when applying a Normandy recipe of the above types has failed.
196 This event was generated to correspond to the Legacy Telemetry event
197 normandy.enrollFailed#addon_rollout.
198 bugs: *normandy_enrollFailed_bugs
199 data_reviews: *normandy_enrollFailed_data_reviews
200 notification_emails: *normandy_enrollFailed_emails
202 extra_keys: *normandy_enrollFailed_extra
203 telemetry_mirror: Normandy_Enrollfailed_AddonRollout
205 enroll_failed_nimbus_experiment:
208 Sent when applying a Normandy recipe of the above types has failed.
209 This event was generated to correspond to the Legacy Telemetry event
210 normandy.enrollFailed#nimbus_experiment.
211 bugs: *normandy_enrollFailed_bugs
212 data_reviews: *normandy_enrollFailed_data_reviews
213 notification_emails: *normandy_enrollFailed_emails
215 extra_keys: *normandy_enrollFailed_extra
216 telemetry_mirror: Normandy_Enrollfailed_NimbusExperiment
221 This event is fired when a client detects that a recipe of the ahove
222 types has changed on the server, and the new version of the recipe
223 is being applied over an existing, older version previously fetched
225 This event was generated to correspond to the Legacy Telemetry event
226 normandy.update#addon_study.
227 bugs: &normandy_update_bugs
228 - https://bugzil.la/1443560
229 - https://bugzil.la/1474413
230 data_reviews: &normandy_update_data_reviews
231 - https://bugzil.la/1443560
232 - https://bugzil.la/1474413
233 notification_emails: &normandy_update_emails
234 - normandy-notifications@mozilla.com
236 extra_keys: &normandy_update_extra
239 The `value` of the event. Mirrors to the Legacy Telemetry
240 event's `value` parameter.
244 For preference_rollout recipes, the state of the rollout that had been applied previously.
249 For addon_study recipes, the ID of the addon that was updated.
253 For addon_study recipes, the version of the addon that was installed.
257 The branch that was updated.
261 A unique ID for this enrollment that will be included in all related Telemetry.
263 telemetry_mirror: Normandy_Update_AddonStudy
265 update_preference_rollout:
268 This event is fired when a client detects that a recipe of the ahove
269 types has changed on the server, and the new version of the recipe
270 is being applied over an existing, older version previously fetched
272 This event was generated to correspond to the Legacy Telemetry event
273 normandy.update#preference_rollout.
274 bugs: *normandy_update_bugs
275 data_reviews: *normandy_update_data_reviews
276 notification_emails: *normandy_update_emails
278 extra_keys: *normandy_update_extra
279 telemetry_mirror: Normandy_Update_PreferenceRollout
281 update_addon_rollout:
284 This event is fired when a client detects that a recipe of the ahove
285 types has changed on the server, and the new version of the recipe
286 is being applied over an existing, older version previously fetched
288 This event was generated to correspond to the Legacy Telemetry event
289 normandy.update#addon_rollout.
290 bugs: *normandy_update_bugs
291 data_reviews: *normandy_update_data_reviews
292 notification_emails: *normandy_update_emails
294 extra_keys: *normandy_update_extra
295 telemetry_mirror: Normandy_Update_AddonRollout
297 update_nimbus_experiment:
300 This event is fired when a client detects that a recipe of the ahove
301 types has changed on the server, and the new version of the recipe
302 is being applied over an existing, older version previously fetched
304 This event was generated to correspond to the Legacy Telemetry event
305 normandy.update#nimbus_experiment.
306 bugs: *normandy_update_bugs
307 data_reviews: *normandy_update_data_reviews
308 notification_emails: *normandy_update_emails
310 extra_keys: *normandy_update_extra
311 telemetry_mirror: Normandy_Update_NimbusExperiment
313 update_failed_addon_study:
316 Sent when applying a new version of a Normandy recipe of the above
317 types (over an existing, older version previously fetched from the
319 This event was generated to correspond to the Legacy Telemetry event
320 normandy.updateFailed#addon_study.
321 bugs: &normandy_updateFailed_bugs
322 - https://bugzil.la/1474413
323 data_reviews: &normandy_updateFailed_data_reviews
324 - https://bugzil.la/1474413
325 notification_emails: &normandy_updateFailed_emails
326 - normandy-notifications@mozilla.com
328 extra_keys: &normandy_updateFailed_extra
331 The `value` of the event. Mirrors to the Legacy Telemetry
332 event's `value` parameter.
336 An error code describing the failure.
340 Extra text describing the failure. Currently only provided for addon_study.
345 The branch that failed to update.
349 A unique ID for this enrollment that will be included in all related Telemetry.
351 telemetry_mirror: Normandy_Updatefailed_AddonStudy
353 update_failed_addon_rollout:
356 Sent when applying a new version of a Normandy recipe of the above
357 types (over an existing, older version previously fetched from the
359 This event was generated to correspond to the Legacy Telemetry event
360 normandy.updateFailed#addon_rollout.
361 bugs: *normandy_updateFailed_bugs
362 data_reviews: *normandy_updateFailed_data_reviews
363 notification_emails: *normandy_updateFailed_emails
365 extra_keys: *normandy_updateFailed_extra
366 telemetry_mirror: Normandy_Updatefailed_AddonRollout
368 unenroll_preference_study:
371 Sent when a Normandy recipe of certain types "ends". N.B. For
372 preference_rollback, this is fired when the recipe is fired (the
373 recipe that "ends" is a corresponding preference_rollout).
374 This event was generated to correspond to the Legacy Telemetry event
375 normandy.unenroll#preference_study.
376 bugs: &normandy_unenroll_bugs
377 - https://bugzil.la/1443560
378 - https://bugzil.la/1843126
379 - https://bugzil.la/1896718
380 - https://bugzil.la/1907649
381 data_reviews: &normandy_unenroll_data_reviews
382 - https://bugzil.la/1443560
383 - https://bugzil.la/1843126
384 - https://bugzil.la/1896718
385 - https://bugzil.la/1907649
386 notification_emails: &normandy_unenroll_emails
387 - normandy-notifications@mozilla.com
388 - nimbus-team@mozilla.com
390 extra_keys: &normandy_unenroll_extra
393 The `value` of the event. Mirrors to the Legacy Telemetry
394 event's `value` parameter.
398 A code describing the reason why the recipe ended.
402 For preference_study, "true" or "false" according to whether we put the preference back the way it was.
407 For addon_study, the ID of the addon that ended.
411 For addon_study, the version of the addon for which the recipe ended.
415 The branch of the experiment that this client was on.
419 A unique ID for this enrollment that will be included in all related Telemetry.
423 For preference_study or nimbus_experiment, the preference that was detected to change that caused the unenrollment.
428 For nimbus_experiment, if reason == "prefFlips-conflict", the conflicting experiment that caused the unenrollment.
433 For nimbus_experiment, if reason == "prefFlips-failed", the name of the pref that failed to set.
438 For nimbus_experiment, if reason = "prefFlips-failed", the type of the existing pref value (one of "bool", "string", "int", or "invalid").
441 telemetry_mirror: Normandy_Unenroll_PreferenceStudy
443 unenroll_addon_study:
446 Sent when a Normandy recipe of certain types "ends". N.B. For
447 preference_rollback, this is fired when the recipe is fired (the
448 recipe that "ends" is a corresponding preference_rollout).
449 This event was generated to correspond to the Legacy Telemetry event
450 normandy.unenroll#addon_study.
451 bugs: *normandy_unenroll_bugs
452 data_reviews: *normandy_unenroll_data_reviews
453 notification_emails: *normandy_unenroll_emails
455 extra_keys: *normandy_unenroll_extra
456 telemetry_mirror: Normandy_Unenroll_AddonStudy
458 unenroll_preference_rollback:
461 Sent when a Normandy recipe of certain types "ends". N.B. For
462 preference_rollback, this is fired when the recipe is fired (the
463 recipe that "ends" is a corresponding preference_rollout).
464 This event was generated to correspond to the Legacy Telemetry event
465 normandy.unenroll#preference_rollback.
466 bugs: *normandy_unenroll_bugs
467 data_reviews: *normandy_unenroll_data_reviews
468 notification_emails: *normandy_unenroll_emails
470 extra_keys: *normandy_unenroll_extra
471 telemetry_mirror: Normandy_Unenroll_PreferenceRollback
473 unenroll_addon_rollback:
476 Sent when a Normandy recipe of certain types "ends". N.B. For
477 preference_rollback, this is fired when the recipe is fired (the
478 recipe that "ends" is a corresponding preference_rollout).
479 This event was generated to correspond to the Legacy Telemetry event
480 normandy.unenroll#addon_rollback.
481 bugs: *normandy_unenroll_bugs
482 data_reviews: *normandy_unenroll_data_reviews
483 notification_emails: *normandy_unenroll_emails
485 extra_keys: *normandy_unenroll_extra
486 telemetry_mirror: Normandy_Unenroll_AddonRollback
488 unenroll_nimbus_experiment:
491 Sent when a Normandy recipe of certain types "ends". N.B. For
492 preference_rollback, this is fired when the recipe is fired (the
493 recipe that "ends" is a corresponding preference_rollout).
494 This event was generated to correspond to the Legacy Telemetry event
495 normandy.unenroll#nimbus_experiment.
496 bugs: *normandy_unenroll_bugs
497 data_reviews: *normandy_unenroll_data_reviews
498 notification_emails: *normandy_unenroll_emails
500 extra_keys: *normandy_unenroll_extra
501 telemetry_mirror: Normandy_Unenroll_NimbusExperiment
503 unenroll_failed_preference_rollback:
506 Sent when unenrolling a user fails (see the unenroll event).
507 This event was generated to correspond to the Legacy Telemetry event
508 normandy.unenrollFailed#preference_rollback.
509 bugs: &normandy_unenrollFailed_bugs
510 - https://bugzil.la/1443560
511 - https://bugzil.la/1693402
512 data_reviews: &normandy_unenrollFailed_data_reviews
513 - https://bugzil.la/1443560
514 - https://bugzil.la/1693402
515 notification_emails: &normandy_unenrollFailed_emails
516 - normandy-notifications@mozilla.com
518 extra_keys: &normandy_unenrollFailed_extra
521 The `value` of the event. Mirrors to the Legacy Telemetry
522 event's `value` parameter.
526 A code describing the reason the unenroll failed.
530 A unique ID for this enrollment that will be included in all related Telemetry.
534 For preference_study, the preference that was detected to change that caused the attempted unenrollment.
538 The function that caused the stop to happen, included on Nightly to aid debugging.
542 The code that would had been used for the unenrollment, had it not failed.
544 telemetry_mirror: Normandy_Unenrollfailed_PreferenceRollback
546 unenroll_failed_preference_study:
549 Sent when unenrolling a user fails (see the unenroll event).
550 This event was generated to correspond to the Legacy Telemetry event
551 normandy.unenrollFailed#preference_study.
552 bugs: *normandy_unenrollFailed_bugs
553 data_reviews: *normandy_unenrollFailed_data_reviews
554 notification_emails: *normandy_unenrollFailed_emails
556 extra_keys: *normandy_unenrollFailed_extra
557 telemetry_mirror: Normandy_Unenrollfailed_PreferenceStudy
559 unenroll_failed_addon_rollback:
562 Sent when unenrolling a user fails (see the unenroll event).
563 This event was generated to correspond to the Legacy Telemetry event
564 normandy.unenrollFailed#addon_rollback.
565 bugs: *normandy_unenrollFailed_bugs
566 data_reviews: *normandy_unenrollFailed_data_reviews
567 notification_emails: *normandy_unenrollFailed_emails
569 extra_keys: *normandy_unenrollFailed_extra
570 telemetry_mirror: Normandy_Unenrollfailed_AddonRollback
572 unenroll_failed_nimbus_experiment:
575 Sent when unenrolling a user fails (see the unenroll event).
576 This event was generated to correspond to the Legacy Telemetry event
577 normandy.unenrollFailed#nimbus_experiment.
578 bugs: *normandy_unenrollFailed_bugs
579 data_reviews: *normandy_unenrollFailed_data_reviews
580 notification_emails: *normandy_unenrollFailed_emails
582 extra_keys: *normandy_unenrollFailed_extra
583 telemetry_mirror: Normandy_Unenrollfailed_NimbusExperiment
585 graduate_preference_rollout:
588 Sent when a preference rollout ends due to the rolled-out preference
589 becoming a new default.
590 This event was generated to correspond to the Legacy Telemetry event
591 normandy.graduate#preference_rollout.
593 - https://bugzil.la/1443560
595 - https://bugzil.la/1443560
597 - normandy-notifications@mozilla.com
602 The `value` of the event. Mirrors to the Legacy Telemetry
603 event's `value` parameter.
607 A unique ID for this enrollment that will be included in all related Telemetry.
611 The reason the rollout graduated
613 telemetry_mirror: Normandy_Graduate_PreferenceRollout
615 exp_pref_changed_preference_study:
618 This records that a preference that was set by an experiment has
619 been changed away from its experimental value. This can be triggered
620 by a user changing a preference at runtime, by the preference being
621 changed on disk when Firefox is not running, or by the preference
622 already having a user-set value when a user has enrolls in a default
624 This event was generated to correspond to the Legacy Telemetry event
625 normandy.expPrefChanged#preference_study.
627 - https://bugzil.la/1698684
629 - https://bugzil.la/1698684
631 - mcooper@mozilla.com
636 The `value` of the event. Mirrors to the Legacy Telemetry
637 event's `value` parameter.
641 The preference that changed
645 The way that the preference change was detected ("observer", "sideload", or "onEnroll")
649 A unique ID for this enrollment that will be included in all related Telemetry.
651 telemetry_mirror: Normandy_Expprefchanged_PreferenceStudy
653 validation_failed_nimbus_experiment:
656 This records when validation of a recipe fails.
657 This event was generated to correspond to the Legacy Telemetry event
658 normandy.validationFailed#nimbus_experiment.
660 - https://bugzil.la/1762652
662 - https://bugzil.la/1762652
669 The `value` of the event. Mirrors to the Legacy Telemetry
670 event's `value` parameter.
674 Why validation failed (one of "invalid-recipe", "invalid-branch", or "invalid-reason").
678 If reason == invalid-branch, the branch that failed validation.
682 If reason == invalid-feature, the invalid feature ID.
686 If reason == missing-locale, the locale that was missing from the localization table. If reason == missing-l10n-entry, the locale that was missing the localization entries.
691 If reason == missing-l10n-entry, a comma-separated list of missing localization entries.
694 telemetry_mirror: Normandy_Validationfailed_NimbusExperiment
697 type: labeled_quantity
699 For each recipe ID seen by the Normandy client, its last_modified.
700 This metric was generated to correspond to the Legacy Telemetry
701 scalar normandy.recipe_freshness.
703 - https://bugzil.la/1530508
705 - https://bugzil.la/1530508
707 - product-delivery@mozilla.com
710 telemetry_mirror: NORMANDY_RECIPE_FRESHNESS