Source code
Revision control
Copy as Markdown
Other Tools
# 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
# Adding a new metric? We have docs for that!
---
$tags:
- 'Firefox :: Firefox Accounts'
client_association:
uid:
type: string
description: |
The Mozilla Account UID associated with the user.
bugs:
data_reviews:
data_sensitivity:
- highly_sensitive
notification_emails:
- mreid@mozilla.com
- mconley@mozilla.com
expires: never
send_in_pings:
- fx-accounts
legacy_client_id:
type: uuid
description: |
The legacy Telemetry client ID associated with this user profile.
bugs:
data_reviews:
data_sensitivity:
- highly_sensitive
notification_emails:
- mreid@mozilla.com
- mconley@mozilla.com
expires: never
send_in_pings:
- fx-accounts
fxa:
connect_account:
type: event
description: >
Records when a Firefox Account, or a Firefox Account service, is
explicitly connected from the browser via an intentional user action.
This event was generated to correspond to the Legacy Telemetry event
fxa.connect#account.
bugs: &fxa_connect_bugs
data_reviews: &fxa_connect_data_reviews
notification_emails: &fxa_connect_emails
- sync-dev@mozilla.org
expires: never
extra_keys: &fxa_connect_extra
value:
description: >
The `value` of the event. Mirrors to the Legacy Telemetry
event's `value` parameter.
type: string
fxa:
description: >
Whether the account itself was connected or disconnected.
type: string
sync:
description: >
Whether sync was connected or disconnected.
type: string
telemetry_mirror: Fxa_Connect_Account
disconnect_account:
type: event
description: >
Records when a Firefox Account, or a Firefox Account service, is
explicitly disconnected from the browser via an intentional user action.
This event was generated to correspond to the Legacy Telemetry event
fxa.disconnect#account.
bugs: *fxa_connect_bugs
data_reviews: *fxa_connect_data_reviews
notification_emails: *fxa_connect_emails
expires: never
extra_keys: *fxa_connect_extra
telemetry_mirror: Fxa_Disconnect_Account
sync_enabled:
type: boolean
lifetime: application
description: |
Whether the weave service is present and enabled.
Implies `fxa.account_enabled`.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
account_enabled:
type: boolean
lifetime: application
description: |
Whether the user's logged in to an FxA account.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
sendtab_sent:
type: event
description: |
User asked to send a tab to their devices.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
send_in_pings:
- sync
extra_keys:
hashed_device_id:
description: |
A 64-byte hashed string stable for this device + login.
type: string
flow_id:
description: |
A GUID which uniquely identifies this command invocation.
This GUID is the same for every device the tab is sent to.
type: string
stream_id:
description: |
A GUID which uniquely identifies this command invocation's specific target.
This GUID is the same for every device the tab is sent to.
type: string
server_time: &server_time_extra
description: |
The most recent unix timestamp sent from the sync server.
Arrives in the `X-Weave-Timestamp` header.
Omitted in cases where the client has not yet made a request of the
server and whenever else it's unavailable.
Included to improve flow analysis across multiple clients.
type: string
sendtab_received:
type: event
description: |
We've received a sent tab.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
send_in_pings:
- sync
extra_keys:
hashed_device_id:
description: |
A 64-byte hashed string stable for the sender's device + login.
type: string
flow_id:
description: |
A GUID which uniquely identifies this command invocation.
The value for this GUID will be the same as the flowID sent to the client via
`fxa.sendtab_sent`.
type: string
stream_id:
description: |
A GUID which uniquely identifies this command invocation's specific target.
The value for this GUID will be the same as the streamID sent to the client via
`fxa.sendtab_sent`
type: string
reason:
description: |
Why the command is being processed. One of:
- "poll" if part of a fallback polling process
- "push-missed" if it's a push command we previously missed
- "push" if it's a push command we caught
type: string
server_time: *server_time_extra
closetab_sent:
type: event
description: |
User asked to close a tab on their other devices.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
send_in_pings:
- sync
extra_keys:
hashed_device_id:
description: |
A 64-byte hashed string stable for this device + login.
type: string
flow_id:
description: |
A GUID which uniquely identifies this command invocation.
This GUID is the same for every device the closetab command is sent to.
type: string
stream_id:
description: |
A GUID which uniquely identifies this command invocation's specific target.
This GUID is the same for every device the closetab command is sent to.
type: string
server_time: *server_time_extra
closetab_received:
type: event
description: |
We've received orders to close a tab.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- sync-dev@mozilla.org
expires: never
send_in_pings:
- sync
extra_keys:
hashed_device_id:
description: |
A 64-byte hashed string stable for the sender's device + login.
type: string
flow_id:
description: |
A GUID which uniquely identifies this command invocation.
The value for this GUID will be the same as the flowID sent to the client via
`fxa.closetab_sent`.
type: string
stream_id:
description: |
A GUID which uniquely identifies this command invocation's specific target.
The value for this GUID will be the same as the streamID sent to the client via
`fxa.closetab_sent`.
type: string
reason:
description: |
Why the command is being processed. One of:
- "poll" if part of a fallback polling process
- "push-missed" if it's a push command we previously missed
- "push" if it's a push command we caught
type: string
server_time: *server_time_extra
sync_settings:
open_choose_what_to_sync_menu:
type: event
description: |
Records when the user opens the choose what to sync menu.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- sync-dev@mozilla.org
expires: never
extra_keys:
why:
description: |
Records why the user opened the choose what to sync menu. Value is callToAction, setupSync,
or manageSyncSettings.
type: string
save:
type: event
description: |
Records when the user clicks the save button after opening the choose what to sync menu.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- sync-dev@mozilla.org
expires: never
extra_keys:
enabled_engines:
description: |
A comma-delimited list of engines that were enabled by the user.
type: string
disabled_engines:
description: |
A comma-delimited list of engines that were disabled by the user.
type: string