提交 a1bbdfd8 编写于 作者: G gccgdb1234

doc: correct some contents not proper for cloud

上级 8034de19
...@@ -18,11 +18,7 @@ Users should not use taosdump to back up raw data, environment settings, hardwar ...@@ -18,11 +18,7 @@ Users should not use taosdump to back up raw data, environment settings, hardwar
## Installation ## Installation
There are two ways to install taosdump: Please refer to [Install taosTools](https://docs.tdengine.com/cloud/tools/taosdump/#installation).
- Install the taosTools official installer. Please find taosTools from [All download links](https://www.tdengine.com/all-downloads) page and download and install it.
- Compile taos-tools separately and install it. Please refer to the [taos-tools](https://github.com/taosdata/taos-tools) repository for details.
## Common usage scenarios ## Common usage scenarios
......
...@@ -10,15 +10,15 @@ Prometheus provides `remote_read` interface to leverage other database products ...@@ -10,15 +10,15 @@ Prometheus provides `remote_read` interface to leverage other database products
## Install Prometheus ## Install Prometheus
Please refer to [Install Prometheus](../../data-in/prometheus#install-prometheus). Please refer to [Install Prometheus](https://docs.tdengine.com/cloud/data-in/prometheus#install-prometheus).
## Configure Prometheus ## Configure Prometheus
Please refer to [Configure Prometheus](../../data-in/prometheus/#configure-prometheus). Please refer to [Configure Prometheus](https://docs.tdengine.com/cloud/prometheus/#configure-prometheus).
## Start Prometheus ## Start Prometheus
Please refer to [Start Prometheus](../../data-in/prometheus/#start-prometheus). Please refer to [Start Prometheus](https://docs.tdengine.com/cloud/data-in/prometheus/#start-prometheus).
## Verify Remote Read ## Verify Remote Read
......
...@@ -9,6 +9,8 @@ description: "taosBenchmark (once called taosdemo ) is a tool for testing the pe ...@@ -9,6 +9,8 @@ description: "taosBenchmark (once called taosdemo ) is a tool for testing the pe
taosBenchmark (formerly taosdemo ) is a tool for testing the performance of TDengine products. taosBenchmark can test the performance of TDengine's insert, query, and subscription functions and simulate large amounts of data generated by many devices. taosBenchmark can be configured to generate user defined databases, supertables, subtables, and the time series data to populate these for performance benchmarking. taosBenchmark is highly configurable and some of the configurations include the time interval for inserting data, the number of working threads and the capability to insert disordered data. The installer provides taosdemo as a soft link to taosBenchmark for compatibility with past users. taosBenchmark (formerly taosdemo ) is a tool for testing the performance of TDengine products. taosBenchmark can test the performance of TDengine's insert, query, and subscription functions and simulate large amounts of data generated by many devices. taosBenchmark can be configured to generate user defined databases, supertables, subtables, and the time series data to populate these for performance benchmarking. taosBenchmark is highly configurable and some of the configurations include the time interval for inserting data, the number of working threads and the capability to insert disordered data. The installer provides taosdemo as a soft link to taosBenchmark for compatibility with past users.
**Please be noted that in the context of TDengine cloud service, non privileged user can't create database using any tool, including taosBenchmark. The database needs to be firstly created in the data explorer in TDengine cloud service console. For any content about creating database in this document, the user needs to ignore and create the database manually inside TDengine cloud service.**
## Installation ## Installation
To use taosBenchmark, you need to download and install [taosTools](https://tdengine.com/assets-download/cloud/taosTools-2.1.3-Linux-x64.tar.gz). Before installing taosTools, please firstly download and install [TDengine CLI](https://docs.tdengine.com/cloud/tools/cli/#installation). To use taosBenchmark, you need to download and install [taosTools](https://tdengine.com/assets-download/cloud/taosTools-2.1.3-Linux-x64.tar.gz). Before installing taosTools, please firstly download and install [TDengine CLI](https://docs.tdengine.com/cloud/tools/cli/#installation).
...@@ -29,27 +31,6 @@ taosBenchmark supports the complete performance testing of TDengine by providing ...@@ -29,27 +31,6 @@ taosBenchmark supports the complete performance testing of TDengine by providing
**Make sure that the TDengine cluster is running correctly before running taosBenchmark. ** **Make sure that the TDengine cluster is running correctly before running taosBenchmark. **
### Run without command-line arguments
Execute the following commands to quickly experience taosBenchmark's default configuration-based write performance testing of TDengine.
```bash
export TDENGINE_CLOUD_DSN="<DSN>"
taosBenchmark
```
When run without parameters, taosBenchmark connects to the TDengine cluster specified in `/etc/taos` by default and creates a database named `test`, a super table named `meters` under the test database, and 10,000 tables under the super table with 10,000 records written to each table. Note that if there is already a database named "test" this command will delete it first and create a new database.
### Run with command-line configuration parameters
The `-f <json_file>` argument cannot be used when running taosBenchmark with command-line parameters and controlling its behavior. Users must specify all configuration parameters from the command-line. The following is an example of testing taosBenchmark writing performance using the command-line approach.
```bash
taosBenchmark -I stmt -n 200 -t 100
```
Using the above command, `taosBenchmark` will create a database named `test`, create a super table `meters` in it, create 100 sub-tables in the super table and insert 200 records for each sub-table using parameter binding.
### Run with the configuration file ### Run with the configuration file
A sample configuration file is provided in the taosBenchmark installation package under `<install_directory>/examples/taosbenchmark-json`. A sample configuration file is provided in the taosBenchmark installation package under `<install_directory>/examples/taosbenchmark-json`.
...@@ -64,36 +45,183 @@ taosBenchmark -f json-file ...@@ -64,36 +45,183 @@ taosBenchmark -f json-file
#### Configuration file examples #### Configuration file examples
<details>
<summary>insert.json</summary>
```json ```json
{{#include /taos-tools/example/insert.json}} {
``` "filetype": "insert",
"cfgdir": "/etc/taos",
"host": "127.0.0.1",
"port": 6030,
"user": "root",
"password": "taosdata",
"connection_pool_size": 8,
"thread_count": 4,
"create_table_thread_count": 7,
"result_file": "./insert_res.txt",
"confirm_parameter_prompt": "no",
"insert_interval": 0,
"interlace_rows": 100,
"num_of_records_per_req": 100,
"prepared_rand": 10000,
"chinese": "no",
"databases": [
{
"dbinfo": {
"name": "test",
"drop": "no",
"replica": 1,
"precision": "ms",
"keep": 3650,
"minRows": 100,
"maxRows": 4096,
"comp": 2
},
"super_tables": [
{
"name": "meters",
"child_table_exists": "no",
"childtable_count": 10000,
"childtable_prefix": "d",
"escape_character": "yes",
"auto_create_table": "no",
"batch_create_tbl_num": 5,
"data_source": "rand",
"insert_mode": "taosc",
"non_stop_mode": "no",
"line_protocol": "line",
"insert_rows": 10000,
"childtable_limit": 10,
"childtable_offset": 100,
"interlace_rows": 0,
"insert_interval": 0,
"partial_col_num": 0,
"disorder_ratio": 0,
"disorder_range": 1000,
"timestamp_step": 10,
"start_timestamp": "2020-10-01 00:00:00.000",
"sample_format": "csv",
"sample_file": "./sample.csv",
"use_sample_ts": "no",
"tags_file": "",
"columns": [
{
"type": "FLOAT",
"name": "current",
"count": 1,
"max": 12,
"min": 8
},
{ "type": "INT", "name": "voltage", "max": 225, "min": 215 },
{ "type": "FLOAT", "name": "phase", "max": 1, "min": 0 }
],
"tags": [
{
"type": "TINYINT",
"name": "groupid",
"max": 10,
"min": 1
},
{
"name": "location",
"type": "BINARY",
"len": 16,
"values": ["San Francisco", "Los Angles", "San Diego",
"San Jose", "Palo Alto", "Campbell", "Mountain View",
"Sunnyvale", "Santa Clara", "Cupertino"]
}
]
}
]
}
]
}
</details> ```
#### Query Scenario JSON Profile Example #### Query Scenario JSON Profile Example
<details>
<summary>query.json</summary>
```json ```json
{{#include /taos-tools/example/query.json}} {
``` "filetype": "query",
"cfgdir": "/etc/taos",
"host": "127.0.0.1",
"port": 6030,
"user": "root",
"password": "taosdata",
"confirm_parameter_prompt": "no",
"databases": "test",
"query_times": 2,
"query_mode": "taosc",
"specified_table_query": {
"query_interval": 1,
"concurrent": 3,
"sqls": [
{
"sql": "select last_row(*) from meters",
"result": "./query_res0.txt"
},
{
"sql": "select count(*) from d0",
"result": "./query_res1.txt"
}
]
},
"super_table_query": {
"stblname": "meters",
"query_interval": 1,
"threads": 3,
"sqls": [
{
"sql": "select last_row(ts) from xxxx",
"result": "./query_res2.txt"
}
]
}
}
</details> ```
#### Subscription JSON configuration example #### Subscription JSON configuration example
<details>
<summary>subscribe.json</summary>
```json ```json
{{#include /taos-tools/example/subscribe.json}} {
``` "filetype": "subscribe",
"cfgdir": "/etc/taos",
"host": "127.0.0.1",
"port": 6030,
"user": "root",
"password": "taosdata",
"databases": "test",
"specified_table_query": {
"concurrent": 1,
"mode": "sync",
"interval": 1000,
"restart": "yes",
"keepProgress": "yes",
"resubAfterConsume": 10,
"sqls": [
{
"sql": "select avg(current) from meters where location = 'beijing';",
"result": "./subscribe_res0.txt"
}
]
},
"super_table_query": {
"stblname": "meters",
"threads": 1,
"mode": "sync",
"interval": 1000,
"restart": "yes",
"keepProgress": "yes",
"sqls": [
{
"sql": "select phase from xxxx where groupid > 3;",
"result": "./subscribe_res1.txt"
}
]
}
}
</details> ```
## Command-line argument in detailed ## Command-line argument in detailed
...@@ -142,9 +270,6 @@ taosBenchmark -f json-file ...@@ -142,9 +270,6 @@ taosBenchmark -f json-file
- **-n/--records <recordNum\>** : - **-n/--records <recordNum\>** :
The default value of the number of records inserted in each sub-table is 10000. The default value of the number of records inserted in each sub-table is 10000.
- **-d/--database <dbName\>** :
The name of the database used, the default value is `test`.
- **-b/--data-type <colType\>** : - **-b/--data-type <colType\>** :
specify the type of the data columns of the super table. It defaults to three columns of type FLOAT, INT, and FLOAT if not used. specify the type of the data columns of the super table. It defaults to three columns of type FLOAT, INT, and FLOAT if not used.
...@@ -198,9 +323,6 @@ taosBenchmark -A INT,DOUBLE,NCHAR,BINARY\(16\) ...@@ -198,9 +323,6 @@ taosBenchmark -A INT,DOUBLE,NCHAR,BINARY\(16\)
- **-F/--prepare_rand <Num\>** : - **-F/--prepare_rand <Num\>** :
Specify the number of unique values in the generated random data. A value of 1 means that all data are equal. The default value is 10000. Specify the number of unique values in the generated random data. A value of 1 means that all data are equal. The default value is 10000.
- **-a/--replica <replicaNum\>** :
Specify the number of replicas when creating the database. The default value is 1.
- **-V/--version** : - **-V/--version** :
Show version information only. Users should not use it with other parameters. Show version information only. Users should not use it with other parameters.
...@@ -228,14 +350,6 @@ The parameters listed in this section apply to all function modes. ...@@ -228,14 +350,6 @@ The parameters listed in this section apply to all function modes.
`filetype` must be set to `insert` in the insertion scenario. See [General Configuration Parameters](#General Configuration Parameters) `filetype` must be set to `insert` in the insertion scenario. See [General Configuration Parameters](#General Configuration Parameters)
#### Database related configuration parameters
The parameters related to database creation are configured in `dbinfo` in the json configuration file, as follows. The other parameters correspond to the database parameters specified when `create database` in [../../taos-sql/database].
- **name**: specify the name of the database.
- **drop**: indicate whether to delete the database before inserting. The default is true.
#### Stream processing related configuration parameters #### Stream processing related configuration parameters
The parameters for creating streams are configured in `stream` in the json configuration file, as shown below. The parameters for creating streams are configured in `stream` in the json configuration file, as shown below.
......
...@@ -17,7 +17,7 @@ Users should not use taosdump to back up raw data, environment settings, hardwar ...@@ -17,7 +17,7 @@ Users should not use taosdump to back up raw data, environment settings, hardwar
## Installation ## Installation
To use taosdump, you need to download and install [taosTools](https://tdengine.com/assets-download/cloud/taosTools-2.1.3-Linux-x64.tar.gz). Before installing taosTools, please firstly download and install [TDengine CLI](../cli/#installation). To use taosdump, you need to download and install [taosTools](https://tdengine.com/assets-download/cloud/taosTools-2.1.3-Linux-x64.tar.gz). Before installing taosTools, please firstly download and install [TDengine CLI](https://docs.tdengine.com/cloud/tools/cli/#installation).
Decompress the package and install. Decompress the package and install.
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册