Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 17 KB

metrics.md

File metadata and controls

94 lines (66 loc) · 17 KB

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.

The following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
distribution.channel_name string The distribution channel name of this application. We use this field to recognize Firefox Reality is distributed to which channels, such as wavevrStore, oculusvr, picovr,etc. 1, 2, 3 2021-05-01
firefox_account.sign_in event The user starts the sign in flow 1, 2, 3 2021-05-01
firefox_account.sign_in_result event The user finishes the sign in flow 1, 2, 3
  • state: The result of the sign in flow. True in case of success, false in case of error
2021-05-01
firefox_account.sign_out event A user pressed the sign out button on the sync account page and was successfully signed out of FxA 1, 2, 3 2021-05-01

metrics

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

See the Glean SDK documentation for the metrics ping.

The following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
distribution.channel_name string The distribution channel name of this application. We use this field to recognize Firefox Reality is distributed to which channels, such as wavevrStore, oculusvr, picovr,etc. 1, 2, 3 2021-05-01
firefox_account.bookmarks_sync_status boolean Bookmarks sync engine status. True means that the bookmarks sync status is enabled, false otherwise. 1, 2, 3 2021-05-01
firefox_account.history_sync_status boolean History sync engine status. True means that the history sync status is enabled, false otherwise. 1, 2, 3 2021-05-01
firefox_account.received_tab labeled_counter Number of received tabs per day 1, 2, 3
  • desktop
  • mobile
  • tablet
  • tv
  • vr
  • unknown
2021-05-01
firefox_account.tab_sent counter Number of tabs successfully sent per day 1, 2, 3 2021-05-01
immersive.duration timing_distribution Measuring if users use WebXR APIs to enter XR immersive mode. How long they stay in this mode. (It starts from users call navigator.xr.requestSession() and be ended when the XRSession calls its end().) 1, 2 2021-05-01
pages.page_load timing_distribution Measuring how long each page takes to load. 1, 2 2021-05-01
searches.counts labeled_counter Counting how many searches are queried in a specific search engine. The search engine identifiers are used as keys for this metric. 1, 2, 3 2021-05-01
url.query_type labeled_counter Counting how many URLs are visited in a day, by input method. 1, 2, 3
  • type_link
  • type_query
  • voice_query
2021-05-01
windows.duration timing_distribution Measuring how long windows are kept open. 1, 2 2021-05-01

session-end

This ping is sent at the end of a session (when Firefox Reality switches to the background). We usually send search and UI control metrics at the end of a session.

This ping includes the client id.

Data reviews for this ping:

Bugs related to this ping:

The following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
control.open_new_window counter Counting how many general windows are opened in a session. 1, 2, 3 2021-05-01
distribution.channel_name string The distribution channel name of this application. We use this field to recognize Firefox Reality is distributed to which channels, such as wavevrStore, oculusvr, picovr,etc. 1, 2, 3 2021-05-01
tabs.activated counter Number of tabs activated during a session 1, 2, 3 2021-05-01
tabs.opened labeled_counter Number of tabs opened during a session 1, 2, 3
  • context_menu
  • tabs_dialog
  • bookmarks
  • history
  • fxa_login
  • received
  • pre_existing
  • browser
  • downloads
2021-05-01
url.domains counter Counting how many domains are visited in a session. 1, 2, 3 2021-05-01
url.visits counter Counting how many URL links are visited in a session. 1, 2, 3 2021-05-01
windows.active_in_front_time timing_distribution In Firefox Reality, we allow maximum three windows be placed at front, left, and right positions simultaneously. Using this metric to measure how long the front side window is active in a session. 1, 2 2021-05-01
windows.active_in_left_time timing_distribution In Firefox Reality, we allow maximum three windows be placed at front, left, and right positions simultaneously. Using this metric to measure how long the left side window is active in a session. 1, 2 2021-05-01
windows.active_in_right_time timing_distribution In Firefox Reality, we allow maximum three windows be placed at front, left, and right positions simultaneously. Using this metric to measure how long the right side window is active in a session. 1, 2 2021-05-01
windows.double_pri_window_opened_time timing_distribution Measuring how long a user uses double private windows in a session. 1, 2 2021-05-01
windows.double_window_opened_time timing_distribution Measuring how long a user uses double windows in a session. 1, 2 2021-05-01
windows.movement counter Counting how many times of moving a window in a session. 1, 2 2021-05-01
windows.opened_pri_window_count labeled_counter Counting which multiple private window mode (single, double, triple) users are using in a session. 1, 2
  • single
  • double
  • triple
2021-05-01
windows.opened_window_count labeled_counter Counting which multiple window mode (single, double, triple) users are using in a session. 1, 2
  • single
  • double
  • triple
2021-05-01
windows.resize counter Counting how many times of resizing a window in a session. 1, 2 2021-05-01
windows.single_pri_window_opened_time timing_distribution Measuring how long a user uses single private window in a session. 1, 2 2021-05-01
windows.single_window_opened_time timing_distribution Measuring how long a user uses single window in a session. 1, 2 2021-05-01
windows.triple_pri_window_opened_time timing_distribution Measuring how long a user uses triple private windows in a session. 1, 2 2021-05-01
windows.triple_window_opened_time timing_distribution Measuring how long a user uses triple windows in a session. 1, 2 2021-05-01

Data categories are defined here.