blurts-server/docs/analytics.md

1.9 KiB

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. Also note that we respect your browser's DoNotTrack signal.

Telemetry is collected on the frontend. We currently use both Glean 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.

The data we collect is defined in metrics.yml. Events added to that file on our main branch are picked up by Glean, and thus need to pass the data review before being added.

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.

Debugging

Make sure you are testing in a browser that does not set DoNotTrack, and that the value of APP_ENV in your .env file is local.

Glean

You can debug Glean events using the Glean debug dashboard, where our application ID is fx-monitor-local-dev. You can view an event stream and the raw ping payloads.

GA

We use GA4. There is a debug dashboard, and a Chrome extension that logs events to the console.