README
¶
go-ipfs-datadog-plugin
Datadog tracing plugin for go-ipfs.
NOTE: This plugin doesn't implement any tracing on it's own, it simply configure the Datadog tracer to collect the traces and relay them to the agent. go-ipfs tracing instrumentation is partial at the moment but should improve over time.
NOTE: Plugins only work on Linux and MacOS at the moment. You can track the progress of this issue here: https://github.com/golang/go/issues/19282
Building and Installing
You must build the plugin with the exact version of go used to build the go-ipfs binary you will use it with. You can find the go version for go-ipfs builds from dist.ipfs.io in the build-info file, e.g. https://dist.ipfs.io/go-ipfs/v0.4.22/build-info or by running ipfs version --all
You can build this plugin by running make build. You can then install it into your local IPFS repo by running make install.
Plugins need to be built against the correct version of go-ipfs. This package generally tracks the latest go-ipfs release but if you need to build against a different version, please set the IPFS_VERSION environment variable.
You can set IPFS_VERSION to:
vX.Y.Zto build against that version of IPFS.$commitor$branchto build against a specific go-ipfs commit or branch./absolute/path/to/sourceto build against a specific go-ipfs checkout.
To update the go-ipfs, run:
> make go.mod IPFS_VERSION=version
Manual Installation
Copy datadog-plugin.so to $IPFS_DIR/plugins/datadog-plugin.so (or run make install if you are installing locally)
Caveats
- If you are using go-ipfs 0.4.22 or older, some traces will be lost. See: https://github.com/ipfs/go-ipfs/pull/6672
References
- Boilerplate for this repo is based on https://github.com/ipfs/go-ipfs-example-plugin
License
MIT
Directories