trezor-suite/docs/misc/analytics.md

Analytics

Both web and desktop Suite applications collect anonymous data about how a user interacts with them. Analytics is not mandatory and not all users have it enabled, as it can be opt-out during the onboarding process or later in the settings in the general tab. However, by default, it is enabled in the onboarding process and if the user does not opt-out, the application starts to track his interactions immediately after the onboarding process is completed.

Anonymous data:

Collected data have to be anonymous. This means that Suite should never track any data leaking information about a device or a user.

• device id
• public keys
• transaction id
• ... any other fingerprinting

Tracking process

Data about interactions are transferred in GET HTTP requests encoded in URI.

Data from production builds (codesign branch) are sent to:

• Desktop build: https://data.trezor.io/suite/log/desktop/stable.log
• Web build: https://data.trezor.io/suite/log/web/stable.log

Data from development builds are sent to:

• Desktop build: https://data.trezor.io/suite/log/desktop/develop.log
• Web build: https://data.trezor.io/suite/log/web/develop.log

Data from localhost are not currently tracked anywhere.

List of available configured endpoints:

https://data.trezor.io/suite/log    /desktop   /staging     .log
https://data.trezor.io/suite/log    /desktop   /beta        .log
https://data.trezor.io/suite/log    /desktop   /develop     .log
https://data.trezor.io/suite/log    /desktop   /stable      .log
https://data.trezor.io/suite/log    /web       /staging     .log
https://data.trezor.io/suite/log    /web       /beta        .log
https://data.trezor.io/suite/log    /web       /develop     .log
https://data.trezor.io/suite/log    /web       /stable      .log

Example URI:

https://data.trezor.io/suite/log/web/stable.log?c_v=1.8&c_type=transport-type&c_commit=4d09d88476dab2e6b2fbfb833b749e9ac62251c2&c_instance_id=qlT0xL2XKV&c_session_id=FZjilOYQic&type=bridge&version=2.0.30

Which tracks:

{
  c_v: '1.9',
  c_type: 'transport-type',
  c_commit: '4d09d88476dab2e6b2fbfb833b749e9ac62251c2',
  c_instance_id: 'qlT0xL2XKV',
  c_session_id: 'FZjilOYQic',
  type: 'bridge',
  version: '2.0.30'
}

Attributes which are always tracked:

• c_v: version of analytics
• c_type: type of tracked event
• c_commit: current revision of app
• c_instance_id: until user does not wipe storage, the id is still same
• c_session_id: id changed on every launch of app

Other attributes are connected to a specific type of events.

Specific events can be found in project in analyticsActions.ts file and also in company Notion where implemented events with expected attributes and other notes related to analytics can be found.

Versioning

Whenever there shall be a change in AnalyticsEvent, version variable in analyticsActions.ts should be bumped. Please follow simple semver versioning in format <breaking-change>.<analytics-extended>. Breaking change should bump major version. Any other change bumps minor version.

How does analytics work?

1. User with enabled analytics interacts with the application
2. Events are sent to specific endpoints
3. Collected data are parsed and analysed (can be seen in Keboola)
4. Charts and metrics are created (in Tableau)
5. We know how to improve the application

How to check that events are tracked?

1. Option: Open DevTools, navigate to Network tab, filter traffic by .log and check the Query String Parameters section
2. Option: Get access to Keboola
3. Option: Create a modified build of app with an analytics server URL pointing to your server
4. Option: Edit NAT to resolve requests to https://data.trezor.io/suite/log/web/stable.log to your local server

Changelog

1.9

Changed:

• use stable.log for codesign builds and develop.log otherwise
• suite-ready is now also tracked on initial run

Added:

• suite-ready
  • platformLanguages: string
• device-connect
  • language: string
  • model: string
• settings/device/goto/background
  • custom: boolean
• settings/device/background
  • image: string | undefined (gallery image)
  • format: string | undefined (custom image)
  • size: number | undefined (custom image)
  • resolutionWidth: number | undefined (custom image)
  • resolutionHeight: number | undefined (custom image)
• add-token
  • token: string
• transaction-created
  • action: 'sent' | 'copied' | 'downloaded' | 'replace'
  • symbol: string
  • tokens: string
  • outputsCount: number
  • broadcast: boolean
  • bitcoinRbf: boolean
  • bitcoinLockTime: boolean
  • ethereumData: boolean
  • rippleDestinationTag: boolean
  • ethereumNonce: boolean
  • selectedFee: string
• menu/notifications/toggle
  • value: boolean
• menu/settings/toggle
  • value: boolean
• menu/settings/dropdown
  • option: 'all' | 'general' | 'device' | 'coins'
• menu/goto/tor
• accounts/empty-account/receive

Fixed:

• device-update-firmware
  • toBtcOnly
• accounts/empty-account/buy
  • symbol (lowercase instead of uppercase)

1.8

Added:

• settings/device/update-auto-lock
  • value: string
• suite-ready
  • browserName: string
  • browserVersion: string
  • osName: string
  • osVersion: string
  • windowWidth: number
  • windowHeight: number

Fixed:

• suite-ready
  • suiteVersion
  • c_instance_id
  • c_session_id
• device-update-firmware
  • fromFwVersion (changed separator to dots from commas)
  • fromBlVersion (changed separator to dots from commas)
• analytics/dispose

Removed:

• menu/goto/exchange-index

Changed:

• desktop build is now tracked to stable.log instead of beta.log

1.7

Added:

• send-raw-transaction
  • networkSymbol: string
• device-connect
  • totalDevices: number

1.6

Added:

• suite-ready
  • suiteVersion: string | ""
• device-connect
  • isBitcoinOnly: boolean
• desktop-init
  • desktopOSVersion: string | "" (in format: {platform}_{release})
• accounts/empty-account/buy
  • symbol: string
• account-create
  • tokensCount: number
• transaction-created
  • action: 'sent' | 'copied' | 'downloaded'
  • symbol: string
  • broadcast: boolean
  • outputsCount: number
  • bitcoinRbf: boolean
  • bitcoinLockTime: boolean
  • ethereumData: boolean
  • tokenSent: boolean
• add-token
  • networkSymbol: string
  • addedNth: number

1.5

Added:

• suite-ready
  • theme (dark mode)
• wallet/created
  • type: standard | hidden
• device-disconnect

1.4

Added:

• suite-ready
  • rememberedStandardWallets
  • rememberedHiddenWallets
• analytics/enable
• analytics/dispose
• check-seed/error
• check-seed/success

1.3

Added:

• device-connect
  • backup_type
• router/location-change
  • prevRouterUrl
  • nextRouterUrl

1.2

Added

• suite-ready
  • tor

1.1

Added:

• device-update-firmware:
  • toFwVersion
• suite-ready
  • platformLanguage
  • platform
• device-connect:
  • totalInstances

1.0

• initial version