From 5cc91ef506bf080d27d4553eee7a3b2ad3e493f0 Mon Sep 17 00:00:00 2001 From: Eduardo Patrocinio Date: Thu, 16 Jun 2022 19:36:52 -0300 Subject: [PATCH] Doc: provide more clarify to the usage of check perf command 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 --- etcdctl/README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/etcdctl/README.md b/etcdctl/README.md index dff08d72d768..178c41efbeee 100644 --- a/etcdctl/README.md +++ b/etcdctl/README.md @@ -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 @@ -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.