mirror of
https://github.com/mozilla-services/syncstorage-rs.git
synced 2026-01-21 00:12:14 +01:00
102 lines
3.3 KiB
YAML
102 lines
3.3 KiB
YAML
## This file describes the syncserver-rs daily active user (DAU) metrics.
|
|
## This defines the various allowed metrics that are to be captured.
|
|
## Each metric is written as a JSON blob to the default logger output.
|
|
|
|
---
|
|
# Schema
|
|
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
|
|
|
|
# Category
|
|
syncstorage:
|
|
get_collections:
|
|
type: event
|
|
description: |
|
|
Event to record an instance of sync backend activity initiated by client.
|
|
notification_emails:
|
|
- sync-backend@mozilla.com
|
|
bugs:
|
|
- https://github.com/mozilla-services/syncstorage-rs/issues
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1923967
|
|
expires: never
|
|
|
|
hashed_fxa_uid:
|
|
type: string
|
|
# yamllint disable
|
|
description: >
|
|
User identifier. Uses `hashed_fxa_uid` for accurate count of sync actions.
|
|
Used to determine which user has initiated sync activity.
|
|
This is the Firefox Accounts (FxA) User Identifier (UID) value passed through
|
|
a SHA-256 hash to render a value that is unique, but ensures the privacy of the original UID.
|
|
A single user could make numerous sync actions in a given time
|
|
and this id is required to ensure only a single count of daily active use
|
|
is made, given a number of actions. Sync_id is not used due to possibility
|
|
of new keys being generated during resets or timeouts, whenever encryption
|
|
keys change.
|
|
# yamllint enable
|
|
lifetime: application
|
|
send_in_pings:
|
|
- events
|
|
notification_emails:
|
|
- sync-backend@mozilla.com
|
|
bugs:
|
|
- https://github.com/mozilla-services/syncstorage-rs/issues
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1923967
|
|
expires: never
|
|
|
|
platform:
|
|
type: string
|
|
# yamllint disable
|
|
description: |
|
|
Platform from which sync action was initiated.
|
|
Firefox Desktop, Fenix, or Firefox iOS.
|
|
# yamllint enable
|
|
lifetime: application
|
|
send_in_pings:
|
|
- events
|
|
notification_emails:
|
|
- sync-backend@mozilla.com
|
|
bugs:
|
|
- https://github.com/mozilla-services/syncstorage-rs/issues
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1923967
|
|
expires: never
|
|
|
|
device_family:
|
|
type: string
|
|
# yamllint disable
|
|
description: |
|
|
Device family from which sync action was initiated.
|
|
Desktop PC, Tablet, Mobile, and Other.
|
|
# yamllint enable
|
|
lifetime: application
|
|
send_in_pings:
|
|
- events
|
|
notification_emails:
|
|
- sync-backend@mozilla.com
|
|
bugs:
|
|
- https://github.com/mozilla-services/syncstorage-rs/issues
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1923967
|
|
expires: never
|
|
|
|
hashed_device_id:
|
|
type: string
|
|
# yamllint disable
|
|
description: |
|
|
Hashed device id that is associated with a given account. This is used
|
|
entirely to associate opt-out or removal requests, as they make use of
|
|
the "deletion-request" ping associated with the client side of Sync.
|
|
# yamllint enable
|
|
lifetime: application
|
|
send_in_pings:
|
|
- events
|
|
notification_emails:
|
|
- sync-backend@mozilla.com
|
|
bugs:
|
|
- https://github.com/mozilla-services/syncstorage-rs/issues
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1923967
|
|
expires: never
|