etcd/tools/benchmark
Sahdev Zala 02236b2773 Doc: add installtion instructions for tools
Add missing install commands. Update benchmark to go install as go
get usage is deprecated. Also, improve overall instructions and
experience.

related #13991
2022-04-28 01:13:02 -04:00
..
2022-04-05 15:53:38 +02:00

etcd/tools/benchmark

etcd/tools/benchmark is the official benchmarking tool for etcd clusters.

Installation

Install the tool by running the following command from the etcd source directory.

  $ go install -v ./tools/benchmark

The installation will place executables in the $GOPATH/bin. If $GOPATH environment variable is not set, the tool will be installed into the $HOME/go/bin. You can also find out the installed location by running the following command from the etcd source directory. Make sure that $PATH is set accordingly in your environment.

  $ go list -f "{{.Target}}" ./tools/benchmark

Alternatively, instead of installing the tool, you can use it by simply running the following command from the etcd source directory.

  $ go run ./tools/benchmark

Usage

The following command should output the usage per the latest development.

  $ benchmark --help