vitalif
/
etcd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #9387 from spzala/updatecheckperfdoc 

etcdctl/doc: document check perf auto-compact and defrag options
release-3.4
Gyuho Lee 2018-03-05 10:27:47 -08:00 committed by GitHub
parent 064aeb258b 349773c832
commit 0a33308b8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
etcdctl/README.md
View File

@ -1513,7 +1513,7 @@ CHECK provides commands for checking properties of the etcd cluster.
### CHECK PERF [options] ### CHECK PERF [options]
CHECK PERF checks the performance of the etcd cluster for 60 seconds. CHECK PERF checks the performance of the etcd cluster for 60 seconds. Running the `check perf` often can create a large keyspace history which can be auto compacted and defragmented using the `--auto-compact` and `--auto-defrag` options as described below.
RPC: CheckPerf RPC: CheckPerf
@ -1523,6 +1523,10 @@ RPC: CheckPerf
- prefix -- the prefix for writing the performance check's keys. - prefix -- the prefix for writing the performance check's keys.
- auto-compact -- if true, compact storage with last revision after test is finished.
- auto-defrag -- if true, defragment storage after test is finished.
#### Output #### Output
Prints the result of performance check on different criteria like throughput. Also prints an overall status of the check as pass or fail. Prints the result of performance check on different criteria like throughput. Also prints an overall status of the check as pass or fail.