From 37df089f7f96504e0bcfd081d1bf0355af11a872 Mon Sep 17 00:00:00 2001 From: haoranchen Date: Thu, 6 Feb 2025 10:35:46 +0800 Subject: [PATCH 1/5] Update README.md --- tests/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) 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`. From 0b6f95b35c00628df43f6ed9dab92c69cfe55c64 Mon Sep 17 00:00:00 2001 From: WANG Xu Date: Thu, 6 Feb 2025 15:05:51 +0800 Subject: [PATCH 2/5] Update tests/README.md --- tests/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index 1a0c5754ac..0e57e4d4ef 100644 --- a/tests/README.md +++ b/tests/README.md @@ -239,7 +239,7 @@ Please refer to the [Unit Test](#31-unit-test)、[System Test](#32-system-test) ### 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: +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 && \ From 41a787fbf6f8ebde34f269840f4342976b2ec5ad Mon Sep 17 00:00:00 2001 From: WANG Xu Date: Thu, 6 Feb 2025 15:06:00 +0800 Subject: [PATCH 3/5] Update tests/README.md --- tests/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tests/README.md b/tests/README.md index 0e57e4d4ef..fca159960c 100644 --- a/tests/README.md +++ b/tests/README.md @@ -241,9 +241,12 @@ Please refer to the [Unit Test](#31-unit-test)、[System Test](#32-system-test) 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 +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: From a2a324dd45d03daf36f1dd711a76741eaf1c3788 Mon Sep 17 00:00:00 2001 From: WANG Xu Date: Thu, 6 Feb 2025 15:28:05 +0800 Subject: [PATCH 4/5] refactor: readme about how to run TSBS test Signed-off-by: WANG Xu --- tests/README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/tests/README.md b/tests/README.md index fca159960c..90b64cbff0 100644 --- a/tests/README.md +++ b/tests/README.md @@ -239,30 +239,32 @@ Please refer to the [Unit Test](#31-unit-test)、[System Test](#32-system-test) ### 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: +1. TSBS test can be started locally by running command below. 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 && \ +git clone https://github.com/taosdata/tsbs.git && \ 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` +2. By default, both client and server will be started on the local host. To start the client and server on separate hosts, please follow steps below to configure `test.ini` before starting the test: + +2.1 Modify IP and hostname 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 +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: + +2.2 Passwordless ssh login between the client and server is required; otherwise, please set the ssh login password in `test.int`, for example: + ```ini - serverPass="taosdata123" # server root password -``` -2.3 Run the following command to start the test: -```bash - ./testTsbs.sh +serverPass="taosdata123" # server root password ``` + 3. When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`. From f6db7898fc3029ff42d73be54f178558f85954e9 Mon Sep 17 00:00:00 2001 From: WANG Xu Date: Thu, 6 Feb 2025 15:31:20 +0800 Subject: [PATCH 5/5] docs: add toc [skip ci] Signed-off-by: WANG Xu --- tests/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/tests/README.md b/tests/README.md index 90b64cbff0..b7e4323dee 100644 --- a/tests/README.md +++ b/tests/README.md @@ -9,6 +9,7 @@ - [3.4 Smoke Test](#34-smoke-test) - [3.5 Chaos Test](#35-chaos-test) - [3.6 CI Test](#36-ci-test) + - [3.7 TSBS Test](#37-tsbs-test) # 1. Introduction @@ -239,7 +240,7 @@ Please refer to the [Unit Test](#31-unit-test)、[System Test](#32-system-test) ### 3.7.1 How to run tests? -1. TSBS test can be started locally by running command below. Ensure that your virtual machine supports the AVX instruction set: +TSBS test can be started locally by running command below. Ensure that your virtual machine supports the AVX instruction set: ```bash cd /usr/local/src && \ @@ -250,9 +251,11 @@ cd scripts/tsdbComp && \ ./testTsbs.sh ``` -2. By default, both client and server will be started on the local host. To start the client and server on separate hosts, please follow steps below to configure `test.ini` before starting the test: +### 3.7.2 How to start client and server on different hosts? -2.1 Modify IP and hostname of client and server in `test.ini`: +By default, both client and server will be started on the local host. To start the client and server on separate hosts, please follow steps below to configure `test.ini` before starting the test: + +1. Modify IP and hostname of client and server in `test.ini`: ```ini clientIP="192.168.0.203" # client ip @@ -261,10 +264,12 @@ serverIP="192.168.0.204" # server ip serverHost="trd04" # server hostname ``` -2.2 Passwordless ssh login between the client and server is required; otherwise, please set the ssh login password in `test.int`, for example: +2. Passwordless ssh login between the client and server is required; otherwise, please set the ssh login password in `test.int`, for example: ```ini serverPass="taosdata123" # server root password ``` -3. When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`. +### 3.7.3 Check test results + +When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.