mirror of
https://github.com/ipfs/kubo.git
synced 2025-08-24 02:20:52 +08:00
4255cc3889
* Initial pass at Telemetry plugin Currently, IP Shipyard, with the help of Probelab, monitor and extract Amino/IPFS public network metrics with the use of DHT crawlers and bootstrappers (via peerlog plugin). For example, we log all peer IDs seen and their AgentVersion/Addresses obtained from the `identify` protocol, which provides insights into protocol usage, total number of peers etc. We would like to increase the ability to obtain more insights from the network by collecting some more information in the future, but also to give users more control over this collection (i.e. opt-out). The information collected will not allow unique identification of anyone and is only used for aggregation. Now, this PR explores a way of moving in this direction: * A new "telemetry" fx plugin is in charge of dealing with telemetry * The FX plugin allows to plug and make decisions / take actions during the setup phase: * We can inspect whether we are using Private Networks before the libp2p.Host has been initialized. * We can send telemetry after the libp2p Host is initialized. * Everything is self-contained. Custom builds can remove the plugin altogether without needing to surgically edit the code. As for behaviour: * The user can opt-in/out via EnvVar, file in the repo path or plugin configuration. * Users on private networks or with custom bootstrappers are detected, offered a wall of text explaining why we need telemetry and invited to opt-in. Opt-out happens otherwise on a timeout (with no input). Their preferences are stored. * Users on standard settings are opted-in by default. This is the status quo in Kubo already, except they don't get a chance to opt out. The telemetry libp2p protocol is yet to be defined, but expect something similar to identify, with a protobuf being pushed to bootstrappers or to a specific telemetry node that we define. In the case of pnets, this will be done with a temporary peer. * checkpoint * telemetry plugin: second pass * On first run it generates a UUID and shows a message to the user. * UUID is persistend to "telemetry_uuid" * Sends telemetry 1 minute after boot and every 24h * LogEvent is the thing containing all the telemetry that is sent * Opt-out possible via env-var or plugin configuration * Telemetry: add changelog and environment variable documentation * docs: improved daemon message making it more obvious nothing was sent yet and that user had 15m to out-out plus some debug logs that confirm opt-out * refactor: rename IPFS_TELEMETRY_MODE to IPFS_TELEMETRY * fix: add User-Agent header to telemetry requests --------- Co-authored-by: Andrew Gillis <11790789+gammazero@users.noreply.github.com> Co-authored-by: Marcin Rataj <lidel@lidel.org>
17 lines
710 B
Plaintext
17 lines
710 B
Plaintext
# this file contains plugins to be preloaded
|
|
# empty lines or starting with '#' are ignored
|
|
#
|
|
# name go-path number of the sub-plugin or *
|
|
|
|
ipldgit github.com/ipfs/kubo/plugin/plugins/git *
|
|
iplddagjose github.com/ipfs/kubo/plugin/plugins/dagjose *
|
|
|
|
badgerds github.com/ipfs/kubo/plugin/plugins/badgerds *
|
|
flatfs github.com/ipfs/kubo/plugin/plugins/flatfs *
|
|
levelds github.com/ipfs/kubo/plugin/plugins/levelds *
|
|
pebbleds github.com/ipfs/kubo/plugin/plugins/pebbleds *
|
|
peerlog github.com/ipfs/kubo/plugin/plugins/peerlog *
|
|
fxtest github.com/ipfs/kubo/plugin/plugins/fxtest *
|
|
nopfs github.com/ipfs/kubo/plugin/plugins/nopfs *
|
|
telemetry github.com/ipfs/kubo/plugin/plugins/telemetry *
|