Skip to content

Commit

Permalink
Create doc for check perf command
Browse files Browse the repository at this point in the history
Create a doc for check commands with perf subcommand.

Fixes etcd-io#9072
  • Loading branch information
spzala committed Jan 2, 2018
1 parent e6a46a0 commit abafa8f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions etcdctl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1440,6 +1440,43 @@ Prints etcd version and API version.
# API version: 3.1
```

### Check <subcommand>

CHECK provides commands for checking properties of the etcd cluster.

### CHECK PERF [options]

CHECK PERF checks the performance of the etcd cluster for 60 seconds.

RPC: CheckPerf

#### Options

- load -- the performance check's workload model. Accepted workloads: s(small), m(medium), l(large), xl(xLarge)

- prefix -- the prefix for writing the performance check's keys.

#### Output

Prints the result of performance check on different criteria like throughput. Also prints an overall status of the check as pass or fail.

#### Examples

```bash
./etcdctl check perf --load="s"
# 60 / 60 Booooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo! 100.00%1m0s
# PASS: Throughput is 150 writes/s
# PASS: Slowest request took 0.087509s
# PASS: Stddev is 0.011084s
# PASS
./etcdctl check perf --load="l"
# 60 / 60 Booooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo! 100.00%1m0s
# FAIL: Throughput too low: 6808 writes/s
# PASS: Slowest request took 0.228191s
# PASS: Stddev is 0.033547s
# FAIL
```

## Exit codes

For all commands, a successful execution return a zero exit code. All failures will return non-zero exit codes.
Expand Down

0 comments on commit abafa8f

Please sign in to comment.