android-components/components/service/nimbus/docs/metrics.md

5.8 KiB

Metrics

This document enumerates the metrics collected by this project using the Glean SDK. This project may depend on other projects which also collect metrics. This means you might have to go searching through the dependency tree to get a full picture of everything collected by this project.

Pings

events

This is a built-in ping that is assembled out of the box by the Glean SDK.

See the Glean SDK documentation for the events ping.

All Glean pings contain built-in metrics in the ping_info and client_info sections.

In addition to those built-in metrics, the following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
messaging.malformed event A message was malformed. mozilla-mobile/fenix/issues/24224, mozilla-mobile/firefox-android#1101
  • message_key: The id of the message
never 2
messaging.message_clicked event A message was clicked by the user. mozilla-mobile/fenix/issues/24224, mozilla-mobile/firefox-android#1101
  • action_uuid: The uuid of the action
  • message_key: The id of the message
never 2
messaging.message_dismissed event A message was dismissed by the user. mozilla-mobile/fenix/issues/24224, mozilla-mobile/firefox-android#1101
  • message_key: The id of the message
never 2
messaging.message_expired event A message maxDisplayCount has been surpassed. mozilla-mobile/fenix/issues/24224, mozilla-mobile/firefox-android#1101
  • message_key: The id of the message
never 2
messaging.message_shown event A message was shown to the user. mozilla-mobile/fenix#24426, mozilla-mobile/firefox-android#1101
  • message_key: The id of the message
never 2
nimbus_events.disqualification event Recorded when a user becomes ineligible to continue receiving the treatment for an enrolled experiment, for reasons such as the user opting out of the experiment or no longer matching targeting for the experiment. mozilla-mobile/android-components#9168
  • branch: The branch slug/identifier that was randomly chosen
  • enrollment_id: A unique identifier generated at enrollment time
  • experiment: The slug/unique identifier of the experiment
never 1
nimbus_events.enrollment event Recorded when a user has met the conditions and is first bucketed into an experiment (i.e. targeting matched and they were randomized into a bucket and branch of the experiment). Expected a maximum of once per experiment per user. mozilla-mobile/android-components#9168
  • branch: The branch slug/identifier that was randomly chosen
  • enrollment_id: A unique identifier generated at enrollment time
  • experiment: The slug/unique identifier of the experiment
never 1
nimbus_events.exposure event Recorded when a user actually observes an experimental treatment, or would have observed an experimental treatment if they had been in a branch that would have shown one. mozilla-mobile/android-components#9168
  • branch: The branch slug/identifier that was randomly chosen
  • enrollment_id: A unique identifier generated at enrollment time
  • experiment: The slug/unique identifier of the experiment
never 1
nimbus_events.unenrollment event Recorded when either telemetry is disabled, or the experiment has run for its designed duration (i.e. it is no longer present in the Nimbus Remote Settings collection) mozilla-mobile/android-components#9168
  • branch: The branch slug/identifier that was randomly chosen
  • enrollment_id: A unique identifier generated at enrollment time
  • experiment: The slug/unique identifier of the experiment
never 1

Data categories are defined here.