forked from mirrors/gecko-dev
cb8f7dc12d
The docs are written, at build-time, to '$project/docs/metrics.md'. This additionally enables automatic doc generation for the following components: lib-crash, storage-sync.
5.6 KiB
5.6 KiB
Metrics
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. Sorry about that.
Pings
bookmarks_sync
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.
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 fbade15f2a/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 |
history_sync
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.
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 |