From 349773c8326a1a755e4ad0ff1da5f8285bb56d06 Mon Sep 17 00:00:00 2001 From: "Sahdev P. Zala" Date: Mon, 5 Mar 2018 12:07:59 -0500 Subject: [PATCH] etcdctl/doc: document check perf auto-compact and defrag options Create doc for newly created auto-compact and defrag options in check perf command. --- etcdctl/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/etcdctl/README.md b/etcdctl/README.md index fa373f45b..a12ec904a 100644 --- a/etcdctl/README.md +++ b/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.