This document enumerates the metrics collected by this project. 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.
A ping sent for every bookmarks sync. It doesn't include the client_id because it reports a hashed version of the user's Firefox Account ID.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| bookmarks_sync.failure_reason | labeled_string | Records bookmark sync failure reasons. | 1 |
|
never |
| bookmarks_sync.finished_at | datetime | Records when the bookmark sync finished. | 1 | never | |
| bookmarks_sync.incoming | labeled_counter | Records incoming bookmark record counts. | 1 |
|
never |
| bookmarks_sync.outgoing | labeled_counter | Records outgoing bookmark record counts. | 1 |
|
never |
| bookmarks_sync.outgoing_batches | counter | Records the number of batches needed to upload all outgoing records. | 1 | never | |
| bookmarks_sync.remote_tree_problems | labeled_counter | Records counts for structure problems and divergences in the remote bookmarks tree. These are documented in https://github.com/mozilla/dogear/blob/fbade15f2a4f11215e30b8f428a0a8df3defeaec/src/tree.rs#L1273-L1294. | 1 |
|
never |
| bookmarks_sync.started_at | datetime | Records when the bookmark sync started. | 1 | never | |
| bookmarks_sync.uid | string | The user's hashed Firefox Account ID. | 1 | never | |
| sync.sync_uuid | uuid | Unique identifier for this sync, used to correlate together individual pings for data types that were synchronized together (history, bookmarks, logins). If a data type is synchronized by itself via the legacy 'sync' API (as opposed to the Sync Manager), then this field will not be set on the corresponding ping. | 1 | never |
A ping sent for every history sync. It doesn't include the client_id because it reports a hashed version of the user's Firefox Account ID.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| history_sync.failure_reason | labeled_string | Records why the history sync failed: either due to an authentication error, unexpected exception, or other error. The error strings are truncated and sanitized to omit PII, like URLs and file system paths. | 1 |
|
never |
| history_sync.finished_at | datetime | Records when the history sync finished. This includes the time to download, apply, and upload all records. | 1 | never | |
| history_sync.incoming | labeled_counter | Records incoming history record counts. applied is the number of incoming history pages that were successfully stored or updated in the local database. failed_to_apply is the number of pages that were ignored due to errors. reconciled is the number of pages with new visits locally and remotely, and had their visits merged. |
1 |
|
never |
| history_sync.outgoing | labeled_counter | Records outgoing history record counts. uploaded is the number of records that were successfully sent to the server. failed_to_upload is the number of records that weren't uploaded, and will be retried on the next sync. |
1 |
|
never |
| history_sync.outgoing_batches | counter | Records the number of batches needed to upload all outgoing records. The Sync server has a hard limit on the number of records (and request body bytes) on the number of records that can fit into a single batch, and large syncs may require multiple batches. | 1 | never | |
| history_sync.started_at | datetime | Records when the history sync started. | 1 | never | |
| history_sync.uid | string | The user's hashed Firefox Account ID. | 1 | never | |
| sync.sync_uuid | uuid | Unique identifier for this sync, used to correlate together individual pings for data types that were synchronized together (history, bookmarks, logins). If a data type is synchronized by itself via the legacy 'sync' API (as opposed to the Sync Manager), then this field will not be set on the corresponding ping. | 1 | never |
A ping sent for every logins/passwords sync. It doesn't include the client_id because it reports a hashed version of the user's Firefox Account ID.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| logins_sync.failure_reason | labeled_string | Records why the passwords sync failed: either due to an authentication error, unexpected exception, or other error. The error strings are truncated and sanitized to omit PII, like usernames and passwords. | 1 |
|
never |
| logins_sync.finished_at | datetime | Records when the passwords sync finished. This includes the time to download, apply, and upload all records. | 1 | never | |
| logins_sync.incoming | labeled_counter | Records incoming passwords record counts. applied is the number of incoming passwords entries that were successfully stored or updated in the local database. failed_to_apply is the number of entries that were ignored due to errors. reconciled is the number of entries with changes both locally and remotely that were merged. |
1 |
|
never |
| logins_sync.outgoing | labeled_counter | Records outgoing passwords record counts. uploaded is the number of records that were successfully sent to the server. failed_to_upload is the number of records that weren't uploaded, and will be retried on the next sync. |
1 |
|
never |
| logins_sync.outgoing_batches | counter | Records the number of batches needed to upload all outgoing records. The Sync server has a hard limit on the number of records (and request body bytes) on the number of records that can fit into a single batch, and large syncs may require multiple batches. | 1 | never | |
| logins_sync.started_at | datetime | Records when the passwords sync started. | 1 | never | |
| logins_sync.uid | string | The user's hashed Firefox Account ID. | 1 | never | |
| sync.sync_uuid | uuid | Unique identifier for this sync, used to correlate together individual pings for data types that were synchronized together (history, bookmarks, logins). If a data type is synchronized by itself via the legacy 'sync' API (as opposed to the Sync Manager), then this field will not be set on the corresponding ping. | 1 | never |
A summary ping, sent every time a sync is performed. During each Sync one or more data types could be synchronized, depending on which data types user configured to sync. Alongside with 'sync' ping one or more individual data type specific pings will be sent. For example, if history and bookmarks data types are configured to be synchronized, the following pings will be sent: 'sync', 'history-sync' and 'bookmarks-sync'. Alternatively, if only history is configured to be synchronized then 'sync' and 'history-sync' pings will be sent. In case of a "global failure" where none of the data type syncs could even start, e.g. device is offline, only the 'sync' ping will be sent. This ping doesn't include the client_id because it reports a hashed version of the user's Firefox Account ID.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration |
|---|---|---|---|---|---|
| sync.failure_reason | labeled_string | Records a global sync failure: either due to an authentication error, unexpected exception, or other error that caused the sync to fail. Error strings are truncated and sanitized to omit PII, like URLs and file system paths. | 1 |
|
never |
| sync.sync_uuid | uuid | Unique identifier for this sync, used to correlate together individual pings for data types that were synchronized together (history, bookmarks, logins). If a data type is synchronized by itself via the legacy 'sync' API (as opposed to the Sync Manager), then this field will not be set on the corresponding ping. | 1 | never |