Revision control
Copy as Markdown
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# This file defines the metrics that will be gathered for the "logins"
# storage component.
# These are emitted for all users of the component. Additional metrics
# specific to the *syncing* of logins are defined in a separate "sync_ping"
# package.
#
# Changes to these metrics require data review, which should take into
# consideration the following known consumers of the logins component
# Android bindings:
#
# * Fenix for Android
---
logins_store:
# These track when we need to regenerate the encryption key which causes all
# local data to be lost
key_regenerated_lost:
type: event
description: >
The encryption key was regenerated because it was lost
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- synced-client-integrations@mozilla.com
- bdk@mozilla.com
expires: never
key_regenerated_corrupt:
type: event
description: >
The encryption key was regenerated because it didn't match the encrypted
data
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- synced-client-integrations@mozilla.com
- bdk@mozilla.com
expires: never
key_regenerated_other:
type: event
description: >
The encryption key was regenerated for an unknown reason
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- synced-client-integrations@mozilla.com
- bdk@mozilla.com
expires: never
# These help us understand how much the logins store is being used, and
# whether it's succeeding in the duties asked of it. We'll use them to
# graph e.g. the error rate of applications trying to use the logins store,
# and identify application or platform features that lead to unusually
# high error rates.
read_query_count:
type: counter
description: >
The total number of read operations performed on the logins store.
The count only includes operations triggered by the application, not
e.g. incidental reads performed as part of a sync. It is intended to be
used together with `read_query_error_count` to measure the overall error
rate of read operations on the logins store.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- mhammond@mozilla.com
- synced-client-integrations@mozilla.com
expires: "never"
read_query_error_count:
type: labeled_counter
description: >
The total number of errors encountered during read operations on the
logins store, labeled by type.
It is intended to be used together with `read_query_count` to measure
the overall error rate of read operations on the logins store.
labels:
- interrupted
- storage_error
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- mhammond@mozilla.com
- synced-client-integrations@mozilla.com
expires: "never"
write_query_count:
type: counter
description: >
The total number of write operations performed on the logins store.
The count only includes operations triggered by the application, not
e.g. incidental writes performed as part of a sync. It is intended to
be used together with `write_query_error_count` to measure the overall
error rate of write operations on the logins store.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- mhammond@mozilla.com
- synced-client-integrations@mozilla.com
expires: "never"
write_query_error_count:
type: labeled_counter
description: >
The total number of errors encountered during write operations on the
logins store, labeled by type.
It is intended to be used together with `write_query_count` to measure
the overall error rate of write operations on the logins store.
labels:
- no_such_record
- interrupted
- invalid_record
- storage_error
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- mhammond@mozilla.com
- synced-client-integrations@mozilla.com
expires: "never"