-
Notifications
You must be signed in to change notification settings - Fork 111
Telemetry
For clients that have "send anonymous usage data" enabled Firefox for Fire TV sends a "core" ping and an "event" ping to Mozilla's telemetry service. Sending telemetry can be disabled in the app's settings. Builds of "Firefox for Fire TV" have telemetry enabled by default ("opt-out").
Firefox for Fire TV creates and tries to send a "core" ping whenever the app goes to the background. This core ping uses the same format as Firefox for Android and is documented on firefox-source-docs.mozilla.org.
In addition to the core ping an event ping for UI telemetry is generated and sent as soon as the app is sent to the background.
As part of the event ping the most recent state of the user's setting is sent (default values in bold):
| Setting | Key | Value |
|---|---|---|
| Turbo mode enabled? | tracking_protection_enabled | true/false |
The event ping contains a list of events (see event format on readthedocs.io) for the following actions:
| Event | category | method | object | value |
|---|---|---|---|---|
| Start session (App is in the foreground) | action | foreground | app | |
| Stop session (App is in the background) | action | background | app |
| Event | category | method | object | value | extras. |
|---|---|---|---|---|---|
| Home: tile clicked | action | click | home_tile |
| Event | category | method | object | value | extras. |
|---|---|---|---|---|---|
| Browselane shown | action | show | menu | ||
| Browselane hidden by user * | action | hide | menu | ||
| Home clicked | action | click | menu | home | |
| Settings clicked | action | click | menu | settings | |
| Browser: back clicked | action | click | menu | back | |
| Browser: forward clicked | action | click | menu | forward | |
| Browser: refresh clicked | action | click | menu | refresh |
(*) For browselane hidden, we only capture cases where the user closes the browselane themselves:
- Controller menu button is pressed
- Controller back button is pressed
e.g. we don't log an event when the browselane is closed automatically after "Home" is selected.
| Event | category | method | object | value | extras. |
|---|---|---|---|---|---|
| Remote: back pressed * | action | page | browser | back |
back* |
(*) This event fires only when the browser travels back in history, i.e. this event will not fire if:
- The browser is on the last page in history and back is pressed, returning to home/settings or closing the app
- Back is pressed on youtube.com/tv, where we override a back with ESC in order to exit fullscreen mode
(*) back is a JSON map containing a hard-coded "controller" string:
{
"source": "controller"
}| Event | category | method | object | extras |
|---|---|---|---|---|
| SSL Error From Page | error | page | browser |
error* |
| SSL Error From Resource | error | resource | browser |
error* |
(*)error is a JSON map containing the primary SSL Error
{
"error_code": "SSL_DATE_INVALID" // Primary SSL Error
}| Possible Error Codes |
|---|
| SSL_DATE_INVALID |
| SSL_EXPIRED |
| SSL_IDMISMATCH |
| SSL_NOTYETVALID |
| SSL_UNTRUSTED |
| SSL_INVALID |
| Undefined SSL Error |
- An event ping will contain up to but no more than 500 events
- No more than 40 pings per type (core/event) are stored on disk for upload at a later time
- No more than 100 pings are sent per day
-
Event pings are generated (and stored on disk) whenever the onStop() callback of the main activity is triggered. This happens whenever the main screen of the app is no longer visible (The app is in the background or another screen is displayed on top of the app).
-
Whenever we are storing pings we are also scheduling an upload. We are using Android’s JobScheduler API for that. This allows the system to run the background task whenever it is convenient and certain criterias are met. The only criteria we are specifying is that we require an active network connection. In most cases this job is executed immediately after the app is in the background.
-
Whenever an upload fails we are scheduling a retry. The first retry will happen after 30 seconds (or later if there’s no active network connection at this time). For further retries a exponential backoff policy is used: [30 seconds] * 2 ^ (num_failures - 1)
-
An earlier retry of the upload can happen whenever the app is coming to the foreground and sent to the background again (the previous scheduled job is reset and we are starting all over again).