firefox-ios icon indicating copy to clipboard operation
firefox-ios copied to clipboard

[Telemetry Audit] Move toasts probes to their own toast.yaml file

Open data-sync-user opened this issue 6 months ago • 1 comments

The Task

This task is to move the toasts probes out of the monolithic metrics.yaml file and into their own YAML file with a Toast tag.

You can use the FirefoxTelemetryUtility.sh script to create a new toast.yaml file.

More instructions on using the script can be found in our wiki: https://github.com/mozilla-mobile/firefox-ios/wiki/Adding-Glean-Telemetry-Events-and-Metrics#a-update-the-telemetry-specification-yaml-files

You can look up these probes in the Glean dictionary as well: https://dictionary.telemetry.mozilla.org/apps/firefox_ios

Probes to Move

  • toasts.close_all_tabs.undo_tapped
  • toasts.close_single_tab.undo_tapped

Note: The Toast tag will be automatically applied at the top of your new toast.yaml file created with the FirefoxTelemetryUtility.sh script.

You will need to add the Toast tag to the tags.yaml file. Please preserve alphabetical ordering. The description you can use is as follows: Corresponds to the toast elements which can be shown over any screen in the app to provide feedback for user interaction and to sometimes revert user changes.

Example

You can see an example of this type of work in the following PR: https://github.com/mozilla-mobile/firefox-ios/pull/27083

:information_source: Reference Person

@ih-codes

┆Issue is synchronized with this Jira Task

data-sync-user avatar Jun 13 '25 19:06 data-sync-user

Hey @ih-codes assign it to me, please.

Small note on naming. I see toasts being used in plural everywhere, but in the issue description you specified file name in singular toast.yaml. I did as specified, but maybe it makes more sense to have it in plural toasts.yaml for consistency.

DEADLK avatar Jun 16 '25 09:06 DEADLK

Hey @ih-codes assign it to me, please.

Small note on naming. I see toasts being used in plural everywhere, but in the issue description you specified file name in singular toast.yaml. I did as specified, but maybe it makes more sense to have it in plural toasts.yaml for consistency.

Hey, good eye @DEADLK! Thanks for raising your concern.

We are hoping to eventually rename the toast-related telemetry to follow a toast... singular naming convention as a later ticket item. The reason for this is that, like the context_menu (long press and hold menus), there should only ever be one active toast displayed to the user at a time. 🤔 But again thanks for raising this, the inconsistency was a good catch and it will be a little off for a while until the full renamings are done!

ih-codes avatar Jun 17 '25 15:06 ih-codes