History

Marek Siarkowicz 18f85aedf4 Fix benchmark indexing Signed-off-by: Marek Siarkowicz <siarkowicz@google.com>		2024-11-29 20:51:01 +01:00
..
cmd	Fix benchmark indexing	2024-11-29 20:51:01 +01:00
doc.go	*: add missing godoc package descriptions	2016-05-27 15:15:26 -07:00
main.go	go.mod: use go.etcd.io/etcd/v3 versioning	2020-04-28 00:57:35 +00:00
OWNERS	Automate labels for tools pull requests.	2024-05-12 22:27:19 +12:00
README.md	Doc: add installtion instructions for tools	2022-04-28 01:13:02 -04:00

README.md

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