mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
02236b2773
Add missing install commands. Update benchmark to go install as go get usage is deprecated. Also, improve overall instructions and experience. related #13991
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# etcd-dump-metrics
|
|
|
|
`etcd-dump-metrics` provides metrics for the latest main branch, a given endpoint, or version.
|
|
|
|
## Installation
|
|
|
|
Install the tool by running the following command from the etcd source directory.
|
|
|
|
```
|
|
$ go install -v ./tools/etcd-dump-metrics
|
|
```
|
|
|
|
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/etcd-dump-metrics
|
|
```
|
|
|
|
Alternatively, instead of installing the tool, you can use it by simply running the following command from the etcd source
|
|
directory.
|
|
|
|
```
|
|
$ go run ./tools/etcd-dump-metrics
|
|
```
|
|
|
|
## Usage
|
|
|
|
The following command should output the usage per the latest development.
|
|
|
|
```
|
|
$ etcd-dump-metrics --help
|
|
```
|
|
|
|
An example of usage detail is provided below.
|
|
|
|
### For the latest main branch
|
|
```
|
|
$ etcd-dump-metrics
|
|
```
|
|
|
|
### For the provided endpoint
|
|
```
|
|
$ goreman start
|
|
$ etcd-dump-metrics --addr http://localhost:2379/metrics
|
|
```
|
|
|
|
### Download specific version to temporary directory to fetch metrics
|
|
```
|
|
$ etcd-dump-metrics --debug --download-ver v3.5.3
|
|
$ etcd-dump-metrics --download-ver v3.5.3
|
|
```
|