mozilla-mobile/FirefoxReality/docs/metrics.md

Revision control

Copy as Markdown

<!-- AUTOGENERATED BY glean_parser. DO NOT EDIT. -->
# Metrics
This document enumerates the metrics collected by this project using the [Glean SDK](https://mozilla.github.io/glean/book/index.html).
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](#events)
- [metrics](#metrics)
- [session-end](#session-end)
## 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](https://mozilla.github.io/glean/book/user/pings/events.html).
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| distribution.channel_name |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| firefox_account.sign_in_result |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user finishes the sign in flow |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)|<ul><li>state: The result of the sign in flow. True in case of success, false in case of error</li></ul>|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](https://mozilla.github.io/glean/book/user/pings/metrics.html).
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| distribution.channel_name |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| firefox_account.received_tab |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Number of received tabs per day |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)|<ul><li>desktop</li><li>mobile</li><li>tablet</li><li>tv</li><li>vr</li><li>unknown</li></ul>|2021-05-01 | |
| immersive.duration |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| searches.counts |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counting how many searches are queried in a specific search engine. The search engine `identifier`s are used as keys for this metric. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||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.
**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](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| distribution.channel_name |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| tabs.opened |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Number of tabs opened during a session |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749), [3](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)|<ul><li>context_menu</li><li>tabs_dialog</li><li>bookmarks</li><li>history</li><li>fxa_login</li><li>received</li><li>pre_existing</li><li>browser</li><li>downloads</li></ul>|2021-05-01 | |
| windows.active_in_front_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| windows.active_in_left_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| windows.active_in_right_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |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](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| windows.double_pri_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses double private windows in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| windows.opened_pri_window_count |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counting which multiple private window mode (single, double, triple) users are using in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)|<ul><li>single</li><li>double</li><li>triple</li></ul>|2021-05-01 | |
| windows.opened_window_count |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counting which multiple window mode (single, double, triple) users are using in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)|<ul><li>single</li><li>double</li><li>triple</li></ul>|2021-05-01 | |
| windows.single_pri_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses single private window in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
| windows.triple_pri_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses triple private windows in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/3430#issuecomment-642823166), [2](https://github.com/MozillaReality/FirefoxReality/pull/3896#issuecomment-718171759)||2021-05-01 | |
Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).
<!-- AUTOGENERATED BY glean_parser. DO NOT EDIT. -->