thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-09-20 00:30:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small performance test documentation. (#5408)

Browse Source 
* Docs for performance tests

* docfix

* Better formating

* More English

* Run example

* Update README.md
This commit is contained in:
alesapin 2019-05-25 13:46:08 +03:00 committed by alexey-milovidov
parent b4c5edb15f
commit 7822db5884
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
dbms/tests/performance/README.md Normal file
View File

@ -0,0 +1,32 @@
## ClickHouse performance tests
This directory contains `.xml`-files with performance tests for `clickhouse-performance-test` tool.
### How to write performance test
First of all you should check existing tests don't cover your case. If there are no such tests than you should write your own.
There two types of performance tests:
* First is executed in loop, and have tag `<type>loop</type>` in config.
* Second one is executed only once and have tag `<type>once</type>` in config.
Type `once` should be used only for endless queries. Even if your query really long (10 seconds+), it's better to choose `loop` test.
After you have choosen type, you have to specify `preconditions`. It contains table names. Only `hits_100m_single`, `hits_10m_single`, `test.hits` are available in CI.
The most important part of test is `stop_conditions`. For `loop` test you should always use `min_time_not_changing_for_ms` stop condition. For `once` test you can choose between `average_speed_not_changing_for_ms` and `max_speed_not_changing_for_ms`, but first is preferable. Also you should always specify `total_time_ms` metric. Endless tests will be ignored by CI.
`metrics` and `main_metric` settings are not important and can be ommited, because `loop` tests are always compared by `min_time` metric and `once` tests compared by `max_rows_per_second`.
You can use `substitions`, `create`, `fill` and `drop` queries to prepare test. You can find examples in this folder.
Take into account, that these tests will run in CI which consists of 56-cores and 512 RAM machines. Queries will be executed much faster than on local laptop.
### How to run performance test
You have to run clickhouse-server and after you can start testing:
```
$ clickhouse-performance-test --input-file my_lovely_test1.xml --input-file my_lovely_test2.xml
$ clickhouse-performance-test --input-file /my_lovely_test_dir/
```