Skip to content

Commit

Permalink
MNTOR-3096 - add monitor glean backend (#4544)
Browse files Browse the repository at this point in the history 
* add backend metrics yaml for Glean

---------

Co-authored-by: Sean Rose <[email protected]>
  • Loading branch information
@rhelmer @sean-rose
rhelmer and sean-rose authored Jun 27, 2024
1 parent 13416d6 commit 589bf8c
Show file tree
Hide file tree
Showing 5 changed files with 262 additions and 6 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/glean-probe-scraper.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ name: Glean probe-scraper
on:
push:
paths:
- src/telemetry/metrics.yml
- src/telemetry/metrics.yaml
- src/telemetry/backend-metrics.yaml
pull_request:
paths:
- src/telemetry/metrics.yml
- src/telemetry/metrics.yaml
- src/telemetry/backend-metrics.yaml
jobs:
glean-probe-scraper:
uses: mozilla/probe-scraper/.github/workflows/glean.yaml@main
uses: mozilla/probe-scraper/.github/workflows/glean.yaml@main
39 changes: 39 additions & 0 deletions docs/telemetry/backend/metrics.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!-- AUTOGENERATED BY glean_parser v14.1.2. 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)

## 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).

All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-ping_info-section) and [`client_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section) 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](https://wiki.mozilla.org/Firefox/Data_Collection) |
| ----------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------- |
| account.create | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A new Mozilla Monitor account has been created. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| account.password_change | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | The password for an existing Mozilla Account has been changed, and existing auth tokens have been revoked. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| account.profile_change | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | An existing Mozilla Accounts profile has been changed, for example the primary email address. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| account.remove | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | An existing Mozilla Monitor account has been deleted. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| monitor.plan_tier | [string](https://mozilla.github.io/glean/book/user/metrics/string.html) | Which tier of plan the user is on [Free, Plus] | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| monitor.session_id | [string](https://mozilla.github.io/glean/book/user/metrics/string.html) | An ID that allows us to track “sessions” of the user experience within the product. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| monitor.user_id | [string](https://mozilla.github.io/glean/book/user/metrics/string.html) | Mozilla Monitor-specific user ID. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| mozilla.account_id | [string](https://mozilla.github.io/glean/book/user/metrics/string.html) | Mozilla Accounts ID. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| page.view | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A web page view event distinguishable by the page’s URL. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | <ul><li>path: The path of the page.</li><li>referrer: The referring URL, if any.</li><li>utm_campaign: Attribution campaign.</li><li>utm_content: Attribution content.</li><li>utm_medium: Attribution medium.</li><li>utm_source: Attribution source.</li><li>utm_term: Attribution term.</li></ul> | never | 2 |
| subscription.activate | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A subscription has been activated for this user. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |
| subscription.cancel | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A subscription cancellation has taken effect, and the user is no longer subscribed to Monitor Plus. | [Bug 1896222](https://bugzilla.mozilla.org/show_bug.cgi?id=1896222) | | never | 2 |

Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).

<!-- AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. -->
5 changes: 3 additions & 2 deletions docs/metrics.md → docs/telemetry/frontend/metrics.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- AUTOGENERATED BY glean_parser v10.0.3. DO NOT EDIT. -->
<!-- AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. -->

# Metrics

Expand All @@ -24,6 +24,7 @@ In addition to those built-in metrics, the following metrics are added to the pi
| ---------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | -------------------------------------------------------------------- |
| button.click | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A click on a button that doesn’t fall into one of the two other button categories (call-to-action (CTA) or purchase intent). | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>button_id: The ID of the button that was clicked on, or some way to identify where on the page the interaction is located.</li><li>flow_id: A randomly generated unique identifier for following user flows within the FxA system.</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>session_id: An ID that allows us to track “sessions” of the user experience within the product.</li><li>user_id: Mozilla accounts user ID.</li></ul> | never | 2 |
| collapse.click | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A click to collapse a section on the webpage. | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>button_id: The ID of the button that was clicked on, or some way to identify where on the page the interaction is located.</li><li>flow_id: A randomly generated unique identifier for following user flows within the FxA system.</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>session_id: An ID that allows us to track “sessions” of the user experience within the product.</li><li>user_id: Mozilla accounts user ID.</li></ul> | never | 2 |
| csat_survey.click | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A click on a CSAT survey response button. | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>automated_removal_period: The time period since the first automated removal for the user. [initial, 3-months, 6-months, 12-months]</li><li>experiment_branch: The experiment branch the user is on. [control, treatment]</li><li>last_scan_date: The date on which the user had their last data broker scan. [YYYYMMDD]</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>response_id: The ID of the survey response option.</li><li>survey_id: The ID of the survey, or some way to identify which survey was responded to.</li></ul> | never | 2 |
| cta_button.click | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A click on a button that has a specific call-to-action. | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>button_id: The ID of the button that was clicked on, or some way to identify where on the page the interaction is located.</li><li>flow_id: A randomly generated unique identifier for following user flows within the FxA system.</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>session_id: An ID that allows us to track “sessions” of the user experience within the product.</li><li>user_id: Mozilla accounts user ID.</li></ul> | never | 2 |
| dashboard.view | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A view event of a Monitor user’s dashboard, where a user is able to view their data breaches and broker information. | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>breach_count: Users who run the new free scan will be notified of breaches found during the scan.</li><li>broker_count: Users who run the new free scan will be notified of breaches found during the scan.</li><li>dashboard_tab: Either [action_needed, fixed] depending on where the user is in their dashboard.</li><li>flow_id: A randomly generated unique identifier for following user flows within the FxA system.</li><li>legacy_breach_count: Legacy users of Monitor may already have breaches reported on their dashboard, without having run the new free scan.</li><li>legacy_user: True for users who signed up before data broker scanning was released to the welcome flow.</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>session_id: An ID that allows us to track “sessions” of the user experience within the product.</li><li>user_id: Mozilla accounts user ID.</li></ul> | never | 2 |
| expand.click | [event](https://mozilla.github.io/glean/book/user/metrics/event.html) | A click to expand a section of the webpage. | [Bug 1823766](https://bugzilla.mozilla.org/show_bug.cgi?id=1823766) | <ul><li>button_id: The ID of the button that was clicked on, or some way to identify where on the page the interaction is located.</li><li>flow_id: A randomly generated unique identifier for following user flows within the FxA system.</li><li>path: The path of the page.</li><li>plan_tier: Which tier of plan the user is on [Free, Plus]</li><li>session_id: An ID that allows us to track “sessions” of the user experience within the product.</li><li>user_id: Mozilla accounts user ID.</li></ul> | never | 2 |
Expand All @@ -37,4 +38,4 @@ In addition to those built-in metrics, the following metrics are added to the pi

Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).

<!-- AUTOGENERATED BY glean_parser v10.0.3. DO NOT EDIT. -->
<!-- AUTOGENERATED BY glean_parser v14.1.2. DO NOT EDIT. -->
Loading

0 comments on commit 589bf8c

Please sign in to comment.