diff --git a/app/metrics.yaml b/app/metrics.yaml index 848b9ecf9b..ad8c445dca 100644 --- a/app/metrics.yaml +++ b/app/metrics.yaml @@ -278,3 +278,258 @@ legacy_telemetry: - fxr-telemetry@mozilla.com - dmu@mozilla.com expires: "2020-11-01" + +pages: + page_load: + type: timing_distribution + description: > + Measuring how long each page takes to load. + time_unit: nanosecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + +immersive: + duration: + type: timing_distribution + description: > + 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()`.) + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + +windows: + duration: + type: timing_distribution + description: > + Measuring how long windows are kept open. + time_unit: millisecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + movement: + type: counter + description: > + Counting how many times of moving a window in a session. + send_in_pings: + - session-end + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + resize: + type: counter + description: > + Counting how many times of resizing a window in a session. + send_in_pings: + - session-end + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + active_in_left_time: + type: timing_distribution + description: > + 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. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + active_in_right_time: + type: timing_distribution + description: > + 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. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + active_in_front_time: + type: timing_distribution + description: > + 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. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + single_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses single window in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + double_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses double windows in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + triple_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses triple windows in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + single_pri_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses single private window in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + double_pri_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses double private windows in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + triple_pri_window_opened_time: + type: timing_distribution + description: > + Measuring how long a user uses triple private windows in a session. + send_in_pings: + - session-end + time_unit: microsecond + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2279 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + opened_window_count: + type: labeled_counter + description: > + Counting which multiple window mode (single, double, triple) + users are using in a session. + send_in_pings: + - session-end + labels: + - single + - double + - triple + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2230 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" + opened_pri_window_count: + type: labeled_counter + description: > + Counting which multiple private window mode (single, double, triple) + users are using in a session. + send_in_pings: + - session-end + labels: + - single + - double + - triple + bugs: + - https://github.com/MozillaReality/FirefoxReality/issues/2230 + data_reviews: + - https://github.com/MozillaReality/FirefoxReality/pull/xxx + notification_emails: + - fxr-telemetry@mozilla.com + - dmu@mozilla.com + expires: "2020-11-01" diff --git a/docs/metrics.md b/docs/metrics.md index b3575fb307..1e5b320dfd 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -51,8 +51,11 @@ The following metrics are added to the ping: | firefox_account.history_sync_status |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |History sync engine status. True means that the history sync status is enabled, false otherwise. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-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)||2020-11-01 | | firefox_account.tab_sent |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Number of tabs successfully sent per day |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-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/xxx)||2020-11-01 | +| pages.page_load |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long each page takes to load. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-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)||2020-11-01 | | url.query_type |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Counting how many URLs are visited in a day, by input method. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | +| windows.duration |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long windows are kept open. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-01 | ## session-end @@ -79,6 +82,19 @@ The following metrics are added to the ping: | 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)||2020-11-01 | | url.domains |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many domains are visited in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | | url.visits |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many URL links are visited in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-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/xxx)||2020-11-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/xxx)||2020-11-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/xxx)||2020-11-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/xxx)||2020-11-01 | +| windows.double_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses double windows in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-01 | +| windows.movement |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many times of moving a window in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-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/xxx)||2020-11-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/xxx)||2020-11-01 | +| windows.resize |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many times of resizing a window in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-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/xxx)||2020-11-01 | +| windows.single_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses single window in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-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/xxx)||2020-11-01 | +| windows.triple_window_opened_time |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measuring how long a user uses triple windows in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/xxx)||2020-11-01 |