Skip to content

Commit

Permalink
Doc: provide more clarify to the usage of check perf command
Browse files Browse the repository at this point in the history
This PR describes the workloades `check perf` command,
and the fact that some load model might work while other might fail.

Signed-off-by: Eduardo Patrocinio <epatro@gmail.com>
  • Loading branch information
patrocinio committed Jun 16, 2022
1 parent 7526b9b commit 5cc91ef
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions etcdctl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ Prints the compacted revision.

### WATCH [options] [key or prefix] [range_end] [--] [exec-command arg1 arg2 ...]

Watch watches events stream on keys or prefixes, [key or prefix, range_end) if range_end is given. The watch command runs until it encounters an error or is terminated by the user. If range_end is given, it must be lexicographically greater than key or "\x00".
Watch watches events stream on keys or prefixes, [key or prefix, range_end) if range_end is given. The watch command runs until it encounters an error or is terminated by the user. If range_end is given, it must be lexicographically greater than key or "\x00".

RPC: Watch

Expand Down Expand Up @@ -1505,7 +1505,23 @@ CHECK provides commands for checking properties of the etcd cluster.

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.

Notice that different workload models use different configurations in terms of number of clients and expected throughtput.
Notice that different workload models use different configurations in terms of number of clients and throughtput. Here is the configuration for each load:


| Load | Number of clients | Number of put requests (requests/sec) |
|---------|------|---------|
| Small | 50 | 10000 |
| Medium | 200 | 100000 |
| Large | 500 | 1000000 |
| xLarge | 1000 | 3000000 |

The test checks for the following conditions:

- The throughput should be at least 90% of the issued requets
- All the requests should be done in less than 500 ms
- The standard deviation of the requests should be less than 100 ms


Hence, a workload model may work while another one might fail.


Expand Down

0 comments on commit 5cc91ef

Please sign in to comment.