docs: update taosAdapter doc
This commit is contained in:
t_max
parent
a0ecc3607b
commit
6b92acca50
|
|
@ -63,7 +63,7 @@ Supported InfluxDB parameters are as follows:
|
|||
- `ttl` the lifespan of automatically created subtables, determined by the TTL parameter of the first data entry in the subtable, which cannot be updated. For more information, please refer to the TTL parameter in the [table creation document](../../sql-manual/manage-tables/).
|
||||
|
||||
Note: Currently, InfluxDB's token authentication method is not supported, only Basic authentication and query parameter verification are supported.
|
||||
Example: curl --request POST `http://127.0.0.1:6041/influxdb/v1/write?db=test` --user "root:taosdata" --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"
|
||||
Example: `curl --request POST http://127.0.0.1:6041/influxdb/v1/write?db=test --user "root:taosdata" --data-binary "measurement,host=host1 field1=2i,field2=2.0 1577836800000000000"`
|
||||
|
||||
### Compatible with OpenTSDB JSON and telnet format writing
|
||||
|
||||
|
|
@ -114,7 +114,6 @@ After the installation is complete, you can start the taosAdapter service using
|
|||
|
||||
## Configuration
|
||||
|
||||
|
||||
taosAdapter supports configuration through command-line parameters, environment variables, and configuration files. The default configuration file is `/etc/taos/taosadapter.toml`.
|
||||
|
||||
Command-line parameters take precedence over environment variables, which take precedence over configuration files. The command-line usage is arg=val, such as taosadapter -p=30000 --debug=true, detailed list as follows:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
### Configuring taosAdapter
|
||||
#### Configuring taosAdapter
|
||||
|
||||
Method to configure taosAdapter to receive collectd data:
|
||||
|
||||
|
|
@ -21,11 +21,11 @@ The default database name written by taosAdapter is `collectd`, but you can also
|
|||
|
||||
- You can also use taosAdapter command line parameters or set environment variables to start, to enable taosAdapter to receive collectd data, for more details please refer to the taosAdapter reference manual.
|
||||
|
||||
### Configuring collectd
|
||||
#### Configuring collectd
|
||||
|
||||
collectd uses a plugin mechanism that can write the collected monitoring data to different data storage software in various forms. TDengine supports direct collection plugins and write_tsdb plugins.
|
||||
|
||||
#### Configuring to receive direct collection plugin data
|
||||
1. **Configuring to receive direct collection plugin data**
|
||||
|
||||
Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf).
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ LoadPlugin network
|
|||
</Plugin>
|
||||
```
|
||||
|
||||
#### Configuring write_tsdb plugin data
|
||||
2. **Configuring write_tsdb plugin data**
|
||||
|
||||
Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
### Configuring taosAdapter
|
||||
#### Configuring taosAdapter
|
||||
|
||||
Method to configure taosAdapter to receive icinga2 data:
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ The default database name written by taosAdapter is `icinga2`, but you can also
|
|||
|
||||
- You can also use taosAdapter command line parameters or set environment variables to enable taosAdapter to receive icinga2 data, for more details please refer to the taosAdapter reference manual
|
||||
|
||||
### Configuring icinga2
|
||||
#### Configuring icinga2
|
||||
|
||||
- Enable icinga2's opentsdb-writer (reference link https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer)
|
||||
- Modify the configuration file `/etc/icinga2/features-enabled/opentsdb.conf` filling in \<taosAdapter's host> with the domain name or IP address of the server running taosAdapter, \<port for icinga2> with the corresponding port supported by taosAdapter for receiving icinga2 data (default is 6048)
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
Configuring Prometheus is done by editing the Prometheus configuration file `prometheus.yml` (default location `/etc/prometheus/prometheus.yml`).
|
||||
|
||||
### Configure Third-Party Database Address
|
||||
#### Configure Third-Party Database Address
|
||||
|
||||
Set the `remote_read url` and `remote_write url` to point to the domain name or IP address of the server running the taosAdapter service, the REST service port (taosAdapter defaults to 6041), and the name of the database you want to write to in TDengine, ensuring the URLs are formatted as follows:
|
||||
|
||||
- remote_read url: `http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_read/<database name>`
|
||||
- remote_write url: `http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_write/<database name>`
|
||||
|
||||
### Configure Basic Authentication
|
||||
#### Configure Basic Authentication
|
||||
|
||||
- username: \<TDengine's username>
|
||||
- password: \<TDengine's password>
|
||||
|
||||
### Example configuration of remote_write and remote_read in the prometheus.yml file
|
||||
#### Example configuration of remote_write and remote_read in the prometheus.yml file
|
||||
|
||||
```yaml
|
||||
remote_write:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
### Configure taosAdapter
|
||||
#### Configure taosAdapter
|
||||
|
||||
Method to configure taosAdapter to receive StatsD data:
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ The default database name written by taosAdapter is `statsd`, but you can also m
|
|||
|
||||
- You can also use taosAdapter command line arguments or set environment variables to enable the taosAdapter to receive StatsD data. For more details, please refer to the taosAdapter reference manual.
|
||||
|
||||
### Configure StatsD
|
||||
#### Configure StatsD
|
||||
|
||||
To use StatsD, download its [source code](https://github.com/statsd/statsd). Modify its configuration file according to the example file `exampleConfig.js` found in the root directory of the local source code download. Replace \<taosAdapter's host> with the domain name or IP address of the server running taosAdapter, and \<port for StatsD> with the port that taosAdapter uses to receive StatsD data (default is 6044).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
### Configuring taosAdapter
|
||||
#### Configuring taosAdapter
|
||||
|
||||
To configure taosAdapter to receive data from TCollector:
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ The default database name that taosAdapter writes to is `tcollector`, but you ca
|
|||
|
||||
- You can also use taosAdapter command line arguments or set environment variables to enable the taosAdapter to receive tcollector data. For more details, please refer to the taosAdapter reference manual.
|
||||
|
||||
### Configuring TCollector
|
||||
#### Configuring TCollector
|
||||
|
||||
To use TCollector, download its [source code](https://github.com/OpenTSDB/tcollector). Its configuration options are in its source code. Note: There are significant differences between different versions of TCollector; this only refers to the latest code in the current master branch (git commit: 37ae920).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue