diff --git a/tests/README.md b/tests/README.md index 58747d93f7..1a0c5754ac 100644 --- a/tests/README.md +++ b/tests/README.md @@ -231,3 +231,35 @@ cd tests ### 3.6.2 How to add new cases? Please refer to the [Unit Test](#31-unit-test)、[System Test](#32-system-test) and [Legacy Test](#33-legacy-test) sections for detailed steps to add new test cases, when new cases are added in aboved tests, they will be run automatically by CI test. + + +## 3.7 TSBS Test + +[Time Series Benchmark Suite (TSBS)](https://github.com/timescale/tsbs) is an open-source performance benchmarking platform specifically designed for time-series data processing systems, such as databases. It provides a standardized approach to evaluating the performance of various databases by simulating typical use cases such as IoT and DevOps. + +### 3.7.1 How to run tests? + +1. Clone the code and run the tests locally on your machine. Ensure that your virtual machine supports the AVX instruction set: +```bash + cd /usr/local/src && git clone https://github.com/taosdata/tsbs-internal.git tsbs && \ + cd tsbs && git checkout enh/chr-td-33357 && \ + cd scripts/tsdbComp && ./testTsbs.sh +``` +2. When testing the client and server on separate machines, you should set up your environment as outlined in the steps below: + +2.1 Modify IP and host of client and server in `test.ini` +```ini + clientIP="192.168.0.203" # client ip + clientHost="trd03" # client hostname + serverIP="192.168.0.204" # server ip + serverHost="trd04" # server hostname +``` +2.2 Set up passwordless login between the client and server; otherwise, you'll need to configure the server password: +```ini + serverPass="taosdata123" # server root password +``` +2.3 Run the following command to start the test: +```bash + ./testTsbs.sh +``` +3. When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.