Files
trezor-suite/docs/misc/analytics.md

152 lines
4.1 KiB
Markdown

# Analytics
Suite collects anonymous data on how user interacts with the application. This feature is by default "on". User has to opt-out either on analytics screen that follows
after welcome screen (if starting Suite for the first time) or by unchecking switch in settings.
Data is transferred in GET requests encoded in uri.
## Catalogue of events
Refer to `AnalyticsEvent` type in [analyticsActions.ts](https://github.com/trezor/trezor-suite/blob/develop/packages/suite/src/actions/suite/analyticsActions.ts).
For general overview see [documentation in Notion](https://www.notion.so/e19845789ccb47a0baf36d7f8463f196?v=2183c8228ebb4df38f358d1b2744e1b8).
## Anonymity
Suite should never collect:
- device id
- any fingerprinting
## Data endpoints
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
Currently used endpoints:
| env | Are |
| ---------------------------- |-------------------------------------------------- |
| staging-suite.trezor.io | https://data.trezor.io/suite/log/web/staging.log |
| beta-wallet.trezor.io | https://data.trezor.io/suite/log/web/beta.log |
| suite.trezor.io | https://data.trezor.io/suite/log/web/stable.log |
| any origin | https://data.trezor.io/suite/log/web/develop.log |
| desktop | https://data.trezor.io/suite/log/desktop/stable.log |
## Versioning
Whenever there shall be a change in `AnalyticsEvent` type `version` variable in [analyticsActions.ts](https://github.com/trezor/trezor-suite/blob/develop/packages/suite/src/actions/suite/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.
## Changelog
### 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
### 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