Add dev docs on debugging Glean
The repo isn't really the right place to inform end users, and the doc was outdated anyway, so I just repurposed `analytics.md` for developer-focused documentation.
This commit is contained in:
Vincent
Vincent
Родитель
953bd4b067
Коммит
9a0a3bb577
|
|
@ -1,118 +1,19 @@
|
|||
_Last updated: Mar 21, 2021_
|
||||
_This document is aimed at Mozilla Monitor developers. For more information about what data we collect and how we protect it, see [our Privacy Policy](https://www.mozilla.org/privacy/firefox-monitor/). Also note that we respect your browser's DoNotTrack signal._
|
||||
|
||||
# Firefox Monitor Analytics Plan
|
||||
Telemetry is collected on the frontend. We currently use both [Glean](https://mozilla.github.io/glean/book/index.html) and Google Analytics, with the ambition to transition fully to Glean once it matures more for web usage. We have a `useTelemetry` hook that abstracts over both — though in a limited number of exceptions, Glean will not support our use case, in which case the hook supports sending the data to just GA.
|
||||
|
||||
This is the Analytics plan for Firefox Monitor. It documents our use of Google Analytics and what we do with the information we collect.
|
||||
The data we collect is defined in [`metrics.yml`](../metrics.yml). Events added to that file on our `main` branch are picked up by Glean, and thus need to pass the [data review](https://wiki.mozilla.org/Data_Collection) before being added.
|
||||
|
||||
## Analysis
|
||||
Telemetry code is generated from `metrics.yml` by running `npm run build-glean`, so make sure to re-run that command locally whenever `metrics.yml` is updated.
|
||||
|
||||
**Firefox Monitor uses Google Analytics to collect and organize data. We do this to get a better understanding of what is working, and where we still have work to do.**
|
||||
## Debugging
|
||||
|
||||
**Captured data also helps provide answers to the following questions:**
|
||||
Make sure you are testing in a browser that does not set DoNotTrack.
|
||||
|
||||
**Demographic:**
|
||||
### Glean
|
||||
|
||||
>From which country does the majority of our traffic originate?
|
||||
You can debug Glean events using the [Glean debug dashboard](https://debug-ping-preview.firebaseapp.com/), where our application ID is `fx-monitor-local-dev`. You can view [an event stream](https://debug-ping-preview.firebaseapp.com/stream/fx-monitor-local-dev) and the [raw ping payloads](https://debug-ping-preview.firebaseapp.com/pings/fx-monitor-local-dev).
|
||||
|
||||
>In which language does the majority of our traffic view the site?
|
||||
### GA
|
||||
|
||||
>Which browsers are most commonly used to access Firefox Monitor?
|
||||
|
||||
>Which devices are most commonly used to access Firefox Monitor?
|
||||
|
||||
**User Behavior:**
|
||||
|
||||
>Do users scan their email?
|
||||
|
||||
>Do users scan multiple email addresses?
|
||||
|
||||
>What percentage of users sign up receive alerts from Firefox Monitor?
|
||||
|
||||
>Are users more likely to sign up for alerts before or after scanning their email?
|
||||
|
||||
|
||||
## Collection
|
||||
|
||||
Events are reported using the [Google Analytics 4 Measurement Protocol](https://developers.google.com/analytics/devguides/collection/protocol/ga4).
|
||||
|
||||
We collect data for the following events:
|
||||
|
||||
- [Enhanced measurement events](https://support.google.com/analytics/answer/9216061):
|
||||
### Scan and Add Email Forms
|
||||
|
||||
**`Email Scan Form`** **`Scan Another Email Form`** **`Add Another Email Form`**
|
||||
|
||||
- When a form appears on the page.
|
||||
* `category ` : Form ID
|
||||
* `action` : view
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
- When a user focuses inside a form input.
|
||||
* `eventCategory` : Form ID
|
||||
* `action` : engage
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
- When a user submits a form.
|
||||
* `category` : Form ID
|
||||
* `action` : submit
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
- When a user submits an invalid email.
|
||||
* `category` : Form ID
|
||||
* `action` : failure
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
- When a user submits a valid email.
|
||||
* `category` : Form ID
|
||||
* `action` : success
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
|
||||
### Sign Up Buttons & Links (FxA Entrypoints)
|
||||
|
||||
**`Sign In Button`** - **`Sign Up Button`** **`Sign In Link`** **`About page SignUp Button`** **`Alert Me About New Breaches`** **`Alert Me About New Breaches - Banner`**
|
||||
|
||||
- When a button appears on the page
|
||||
* `category` : Button ID
|
||||
* `action` : view
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
- When a user clicks a link or button.
|
||||
* `category` : Button or Link ID
|
||||
* `action` : engage
|
||||
* `page_location` : Page location ID.
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
**`All Breaches: Fuzzy Finder`** **`All Breaches: Show All Button`** **`About Page: Download Firefox`** **`About Page: Search Your Email`** **`Breach Detail: Change Password Button`** **`Breach Detail: Website URL Link`** **`Remove Email Form`** **`Show All Breaches Button`**
|
||||
|
||||
- When a user clicks a triggering element
|
||||
* `categorty` : Type of Link (Outbound or Internal)
|
||||
* `action` : click / engage
|
||||
* `link_id` : Link ID
|
||||
|
||||
### User menu
|
||||
|
||||
- When a user opens the User menu
|
||||
* `category` : User Menu
|
||||
* `action` : open
|
||||
|
||||
- When a user closes the User menu
|
||||
* `category` : User Menu
|
||||
* `action` : close
|
||||
|
||||
- When a user clicks on one of the User menu links
|
||||
* `category` : User Menu
|
||||
* `action` : click
|
||||
* `link_id` : Link ID
|
||||
|
||||
|
||||
## Opt Out of Google Analytics Tracking
|
||||
|
||||
**Firefox Monitor respects user privacy and honors DNT headers.**
|
||||
|
||||
Before initializing Google Analytics, we check the user's browser settings for a **DNT** signal. If the **DNT** header is enabled, Analytics is never initialized and is not used to collect data for that session.
|
||||
|
||||
>[How Firefox Monitor detects DNT.](https://github.com/schalkneethling/dnt-helper)
|
||||
|
||||
>[How do I turn on the Do Not Track feature?](https://support.mozilla.org/en-US/kb/how-do-i-turn-do-not-track-feature)
|
||||
We use GA4. There is a [debug dashboard](https://analytics.google.com/analytics/web/#/a36116321p314430969/admin/debugview/overview?params=_u..nav%3Dmaui%26_u.dateOption%3Dlast28Days&collectionId=4770438668), and [a Chrome extension](https://chromewebstore.google.com/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna?pli=1) that logs events to the console.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче