The Status module that consumes go-ethereum https://status.im
Go to file
hesterbruikman a506bea6e5
Add user-facing explainer metrics (#2211)
* Add user-facing explainer

Added a user-facing explainer at the top of the doc as we link to this file from the UI.

Moved all content that was already in the doc to below the divider with the heading 'How it works'

* Update _docs/app-metrics.md

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>

* Update _docs/app-metrics.md

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>

* Update _docs/app-metrics.md

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>

* More text edits based on comments

Session key > Batch ID
Regular Chat key > Chat key

* Remove spaces

* Update app-metrics.md

- Remove 'anonymous' claim
- Correct that we believe the data cannot be linked back to you

* Add criteria to include data in validator rules

* Update app-metrics.md

* Replace anonymous from intro

Removing anonymous reference as discussed on Discord. 'Anonymous' is a claim we logically can't make in spite of best effort and current insights; we are not delivering proof. In addition there is the threat model of a phone ending in the wrong hands with the collected data, albeit temporarily stored locally, falling in the wrong hands.

We do want to communicate that the approach is "as privacy preserving as we could possibly make it without it being useless"

anonymous > privacy-preserving
over Waku > over Status' peer-to-peer network (Waku)

* Update app-metrics.md

- Add warning at top
- Update text at the bottom of 'what will never be shared'
- Remove 'Time since last data message sent'
- Changed 'Time since last session' to 'Time since last batch sent' @shivekkhurana can you confirm this is accurate?

* Update app-metrics.md

Replace instance of 'anonymous' in `How it works` with 'end-to-end encrypted'

* Update app-metrics.md

Added: "Status will never use these data for profit."

* Edit to Transmission and deletion

Added that data is deleted locally if not transmitted after 7 days

@Samyoul can you take a look to see if there are more details to add to this section?

* Update app-metrics.md

Remove privacy-preserving as claim in intro and end-to-end encryption to reduce perception of privacy

* Added info banner

Added info note to explicitly state that usage data service is not included in release or nightly builds

* Added links to related PRs

These PRs include a lot of additional information that will be useful for a future dev, also probably me too.

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>
2022-05-17 12:55:53 +02:00
.dependabot Patch/dependabot protocol (#1980) 2020-05-19 00:14:02 +01:00
.github Update package-lock-snitch recipients 2022-05-09 17:24:16 +02:00
.vscode Add go.formatFlags to VS Code settings 2020-01-16 13:18:36 +01:00
_assets Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
_docs Add user-facing explainer metrics (#2211) 2022-05-17 12:55:53 +02:00
_examples go-waku integration (#2247) 2021-06-16 16:19:45 -04:00
account fix: delete account sync keystore (#2652) 2022-05-12 13:06:58 +02:00
api feat: add IPFS rate limiter for downloading stickers and use http server for retrieving stickers (#2611) 2022-05-09 09:07:57 -04:00
appdatabase Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
appmetrics Address linter issues 2022-03-28 13:14:12 +01:00
build/bin add .gitkeep to build/bin so it always exists 2019-03-05 14:22:00 +01:00
cmd Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
common Move services to status-node 2021-07-20 10:57:38 +02:00
config chore: add status.prod fleet (#2583) 2022-03-11 15:48:51 -05:00
connection Address linter issues 2022-03-28 13:14:12 +01:00
contracts Feat/expose registrar address (#2600) 2022-04-04 12:54:44 -04:00
db Address linter issues 2022-03-28 13:14:12 +01:00
discovery feat: obtain external address for rendezvous (#2333) 2021-09-06 09:46:35 -04:00
eth-node Introduce community history archive routine 2022-04-06 13:00:33 +02:00
exportlogs Upgrade geth to 1.9.5 and Whisper (#1617) 2019-10-04 17:21:24 +02:00
extkeys Upgrade geth 2021-07-20 10:57:38 +02:00
images Sync profile picture 2022-04-21 19:50:31 +03:00
ipfs feat: add IPFS rate limiter for downloading stickers and use http server for retrieving stickers (#2611) 2022-05-09 09:07:57 -04:00
logutils Removed unnecessary dependency from logutil package 2021-08-19 11:35:40 +02:00
mailserver Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
metrics metrics: fix p2p_peers_count metrics labels 2021-08-24 11:07:39 +02:00
mobile refactor: reuse nodeconfig instead of loading it from DB 2022-04-22 11:25:33 +04:00
multiaccounts Added mixed case address to the `Account` struct 2022-05-13 16:17:24 +02:00
node feat: get wallet api (#2619) 2022-05-10 09:48:05 +02:00
nodecfg feat: add IPFS rate limiter for downloading stickers and use http server for retrieving stickers (#2611) 2022-05-09 09:07:57 -04:00
notifier Notifier package to interact with gorush notifications (#910) 2018-05-08 16:30:03 +02:00
params feat: add IPFS rate limiter for downloading stickers and use http server for retrieving stickers (#2611) 2022-05-09 09:07:57 -04:00
peers feat: Rpc client manage multiple eth client (#2359) 2021-09-22 13:49:20 -04:00
postgres Anon Metrics Broadcast (#2198) 2021-09-01 13:02:18 +01:00
profiling Add profiling with pprof (#754) 2018-03-23 14:58:40 +01:00
protocol fix: flakey test with order of chats 2022-05-13 16:17:24 +02:00
rpc feat: extract node config from settings to individual tables (#2470) 2022-01-12 16:04:43 -04:00
rtt rewrite mailserver systemd setup to a Makefile 2019-12-04 13:44:05 +01:00
server feat: add IPFS rate limiter for downloading stickers and use http server for retrieving stickers (#2611) 2022-05-09 09:07:57 -04:00
services fix: delete account sync keystore (#2652) 2022-05-12 13:06:58 +02:00
signal Introduce community history archive routine 2022-04-06 13:00:33 +02:00
sqlite Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
static Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
t Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
telemetry feat: Push messages to telemetry server when receiving messages 2021-11-10 09:34:14 +01:00
timesource Move services to status-node 2021-07-20 10:57:38 +02:00
transactions feat: ens register api (#2473) 2022-01-14 12:17:31 +01:00
vendor Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
waku Address linter issues 2022-03-28 13:14:12 +01:00
wakuv2 fix: peer table queries 2022-04-01 18:06:10 -04:00
.codeclimate.yml fix: exclude migrations from codeclimate (#2284) 2021-07-22 14:04:21 -04:00
.dockerignore Ignore *.test files from all folders (#635) 2018-02-08 14:23:08 +02:00
.gitignore feat: add visual identity service (#2550) 2022-03-11 16:17:48 -05:00
.golangci.yml Remove protocol and eth-node submodules (#1835) 2020-02-10 12:22:37 +01:00
.travis.yml Remove e2e tests from steps 2021-07-20 10:57:38 +02:00
BOOTNODE.md docs: clarify purpose and describe ports 2020-02-06 18:44:23 +01:00
CMakeLists.txt fix: cmakelist 2021-09-23 11:31:59 -04:00
CONTRIBUTING.md Update team collaboration forum (#1946) 2020-04-21 08:12:01 +01:00
LICENSE.md Create LICENSE.md 2016-09-21 10:00:29 +08:00
MAILSERVER.md rcp.sh: curl wrapper for easier RPC calls 2021-08-24 11:23:25 +02:00
Makefile Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
README.md Explain how to run Waku node in README (#1921) 2020-04-09 18:33:53 +02:00
RELEASING.md update RELEASING docs links to CI (#1506) 2019-06-28 10:37:34 +02:00
VERSION Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
WAKU.md Create WAKU.md with spec support (#1855) 2020-02-21 17:56:15 +08:00
go.mod Upgrade to go 1.18 2022-05-11 12:39:54 +01:00
go.sum Upgrade to go 1.18 2022-05-11 12:39:54 +01:00