diff --git a/app/metrics.yaml b/app/metrics.yaml index 2ac059b63..32275c72c 100644 --- a/app/metrics.yaml +++ b/app/metrics.yaml @@ -21,10 +21,11 @@ distribution: - https://github.com/MozillaReality/FirefoxReality/issues/1420 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" url: domains: @@ -37,10 +38,11 @@ url: - https://github.com/MozillaReality/FirefoxReality/issues/2230 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" visits: type: counter send_in_pings: @@ -51,10 +53,11 @@ url: - https://github.com/MozillaReality/FirefoxReality/issues/2230 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" query_type: type: labeled_counter description: > @@ -67,10 +70,11 @@ url: - https://github.com/MozillaReality/FirefoxReality/issues/2230 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" searches: counts: @@ -81,10 +85,11 @@ searches: - https://github.com/MozillaReality/FirefoxReality/issues/2230 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2241#issuecomment-557740258 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" tabs: opened: @@ -107,10 +112,11 @@ tabs: - https://github.com/MozillaReality/FirefoxReality/issues/1609 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" activated: type: counter description: > @@ -121,10 +127,11 @@ tabs: - https://github.com/MozillaReality/FirefoxReality/issues/1609 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" firefox_account: sign_in: @@ -135,10 +142,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" sign_in_result: type: event description: > @@ -150,10 +158,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" sign_out: type: event description: > @@ -162,10 +171,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" bookmarks_sync_status: type: boolean lifetime: application @@ -175,10 +185,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" history_sync_status: type: boolean lifetime: application @@ -188,10 +199,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" tab_sent: type: counter description: > @@ -200,10 +212,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" received_tab: type: labeled_counter description: > @@ -219,10 +232,11 @@ firefox_account: - https://github.com/MozillaReality/FirefoxReality/issues/1610 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - manmartin@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" control: open_new_window: @@ -235,7 +249,8 @@ control: - https://github.com/MozillaReality/FirefoxReality/issues/2347 data_reviews: - https://github.com/MozillaReality/FirefoxReality/pull/2348#issuecomment-564736919 + - https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749 notification_emails: - fxr-telemetry@mozilla.com - dmu@mozilla.com - expires: "2020-05-01" + expires: "2020-11-01" diff --git a/docs/metrics.md b/docs/metrics.md index fe734c8dd..0931941ef 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -20,7 +20,7 @@ The following metrics are added to the ping: | Name | Type | Description | Data reviews | Extras | Expiration | | --- | --- | --- | --- | --- | --- | -| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568)||2020-05-01 | +| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | ## events This is a built-in ping that is assembled out of the box by the Glean SDK. @@ -29,10 +29,10 @@ The following metrics are added to the ping: | Name | Type | Description | Data reviews | Extras | Expiration | | --- | --- | --- | --- | --- | --- | -| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568)||2020-05-01 | -| firefox_account.sign_in |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user starts the sign in flow |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837)||2020-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)||2020-05-01 | -| firefox_account.sign_out |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the sign out button on the sync account page and was successfully signed out of FxA |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837)||2020-05-01 | +| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | +| firefox_account.sign_in |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user starts the sign in flow |[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.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)||2020-11-01 | +| firefox_account.sign_out |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user pressed the sign out button on the sync account page and was successfully signed out of FxA |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | ## metrics This is a built-in ping that is assembled out of the box by the Glean SDK. @@ -41,13 +41,13 @@ The following metrics are added to the ping: | Name | Type | Description | Data reviews | Extras | Expiration | | --- | --- | --- | --- | --- | --- | -| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568)||2020-05-01 | -| firefox_account.bookmarks_sync_status |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |Bookmarks sync engine status. True means that the bookmarks sync status is enabled, false otherwise. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837)||2020-05-01 | -| 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)||2020-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)||2020-05-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)||2020-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)||2020-05-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)||2020-05-01 | +| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | +| firefox_account.bookmarks_sync_status |[boolean](https://mozilla.github.io/glean/book/user/metrics/boolean.html) |Bookmarks sync engine status. True means that the bookmarks 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.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 | +| 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 | ## 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. @@ -56,12 +56,12 @@ The following metrics are added to the ping: | Name | Type | Description | Data reviews | Extras | Expiration | | --- | --- | --- | --- | --- | --- | -| control.open_new_window |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many general windows are opened in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2348#issuecomment-564736919)||2020-05-01 | -| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568)||2020-05-01 | -| tabs.activated |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Number of tabs activated during a session |[1](https://github.com/MozillaReality/FirefoxReality/pull/2327#issuecomment-559103837)||2020-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)||2020-05-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)||2020-05-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)||2020-05-01 | +| control.open_new_window |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Counting how many general windows are opened in a session. |[1](https://github.com/MozillaReality/FirefoxReality/pull/2348#issuecomment-564736919), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | +| 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 wavevr, oculusvr, etc. |[1](https://github.com/MozillaReality/FirefoxReality/pull/1854#issuecomment-546214568), [2](https://github.com/MozillaReality/FirefoxReality/pull/3199#issuecomment-617938749)||2020-11-01 | +| tabs.activated |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |Number of tabs activated 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 | +| 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 |