Browse Source

etcdctl/doc: document check perf auto-compact and defrag options

Create doc for newly created auto-compact and defrag options in
check perf command.
Sahdev P. Zala 7 years ago
parent
commit
349773c832
1 changed files with 5 additions and 1 deletions
  1. 5 1
      etcdctl/README.md

+ 5 - 1
etcdctl/README.md

@@ -1513,7 +1513,7 @@ 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.
+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
 
@@ -1523,6 +1523,10 @@ RPC: CheckPerf
 
 - 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
 
 Prints the result of performance check on different criteria like throughput. Also prints an overall status of the check as pass or fail.