未验证 提交 9b2bc603 编写于 作者: sangshuduo's avatar sangshuduo 提交者: GitHub

docs: 3rd parties refine (#11759)

* docs: 3rd parties doc refine

[TD-14841]

* docs: refine 3rd parties doc

[TD-14841]

* docs: correct version number

[TD-14841]

* docs: fix docs format

[TD-14841]

* docs: fix 3rd parties doc format

[TD-14841]

* docs: refine 3rd parties docs

[TD-14841]

* docs: fix docs format

[TD-14841]

* refine 3rd parties docs

* refine 3rd parties docs

* refine 3rd parties docs

* docs: 3rd parties docs refine

* docs: refine 3rd parties docs

* docs: fix 3rd parties docs

* docs: refactor 3rd parties docs

* docs: refine 3rd parties docs

[TD-14841]

* docs: refine 3rd parties doc

[TD-14841]

* docs: refine 3rd parties docs

[TD-14841]
上级 fb69b209
......@@ -13,9 +13,9 @@ Prometheus 提供了 `remote_write` 和 `remote_read` 接口来利用其它数
## 前置条件
要将 Prometheus 数据写入 TDengine, 需要几方面的准备工作。
要将 Prometheus 数据写入 TDengine 需要以下几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- taosAdapter 已经安装并正常运行具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- Prometheus 已经安装。安装 Prometheus 请参考[官方文档](https://prometheus.io/docs/prometheus/latest/installation/)
## 配置步骤
......
......@@ -7,13 +7,13 @@ import Telegraf from "../14-reference/_telegraf.mdx"
Telegraf 是一款十分流行的指标采集开源软件。在数据采集和平台监控系统中,Telegraf 可以采集多种组件的运行信息,而不需要自己手写脚本定时采集,降低数据获取的难度。
只需要将 Telegraf 的配置修改指向 taosAdapter 对应的 url 并修改若干配置项即可将 Telegraf 的数据写入到 TDengine 中。将 Telegraf 的数据存在到 TDengine 中可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
只需要将 Telegraf 的输出配置增加指向 taosAdapter 对应的 url 并修改若干配置项即可将 Telegraf 的数据写入到 TDengine 中。将 Telegraf 的数据存在到 TDengine 中可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
## 前置条件
要将 Telegraf 数据写入 TDengine, 需要几方面的准备工作。
要将 Telegraf 数据写入 TDengine 需要以下几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- taosAdapter 已经安装并正常运行具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- Telegraf 已经安装。安装 Telegraf 请参考[官方文档](https://docs.influxdata.com/telegraf/v1.22/install/)
## 配置步骤
......@@ -21,7 +21,7 @@ Telegraf 是一款十分流行的指标采集开源软件。在数据采集和
## 验证方法
重启 Telegraf:
重启 Telegraf 服务
```
sudo systemctl restart telegraf
......
......@@ -11,9 +11,9 @@ collectd 是一个用来收集系统性能的守护进程。collectd 提供各
## 前置条件
要将 collectd 数据写入 TDengine, 需要几方面的准备工作。
要将 collectd 数据写入 TDengine需要几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行, 具体细节请参考[ taosAdapter 的使用手册](/reference/taosadapter)
- taosAdapter 已经安装并正常运行具体细节请参考[ taosAdapter 的使用手册](/reference/taosadapter)
- collectd 已经安装。安装 collectd 请参考[官方文档](https://collectd.org/download.shtml)
## 配置步骤
......
......@@ -11,7 +11,7 @@ StatsD 是汇总和总结应用指标的一个简单的守护进程,近些年
## 前置条件
要将 StatsD 数据写入 TDengine, 需要几方面的准备工作。
要将 StatsD 数据写入 TDengine 需要以下几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行。具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- StatsD 已经安装。安装 StatsD 请参考[官方文档](https://github.com/statsd/statsd)
......
......@@ -11,7 +11,7 @@ icinga2 是一款开源主机、网络监控软件,最初由 Nagios 网络监
## 前置条件
要将 icinga2 数据写入 TDengine, 需要几方面的准备工作。
要将 icinga2 数据写入 TDengine 需要以下几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行。具体细节请参考[ taosAdapter 的使用手册](/reference/taosadapter)
- icinga2 已经安装。安装 icinga2 请参考[官方文档](https://icinga.com/docs/icinga-2/latest/doc/02-installation/)
......
......@@ -11,7 +11,7 @@ TCollector 是 openTSDB 的一部分,它用来采集客户端日志发送给
## 前置条件
要将 TCollector 数据写入 TDengine, 需要几方面的准备工作。
要将 TCollector 数据写入 TDengine 需要以下几方面的准备工作。
- TDengine 集群已经部署并正常运行
- taosAdapter 已经安装并正常运行。具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- TCollector 已经安装。安装 TCollector 请参考[官方文档](http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html#installation-of-tcollector)
......
......@@ -2,9 +2,10 @@
配置 taosAdapter 接收 collectd 数据的方法:
- 在 taosAdapter 配置文件 (默认位置为 /etc/taos/taosadapter.toml) 中使能配置项
- 在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
```
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
......@@ -13,9 +14,10 @@ dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...
```
其中 taosAdapter 默认写入的数据库名称为 `collectd`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。taosAdapter 需重新启动。
其中 taosAdapter 默认写入的数据库名称为 `collectd`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。
或使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 collectd 数据功能。
......
......@@ -2,9 +2,10 @@
配置 taosAdapter 接收 icinga2 数据的方法:
- 在 taosAdapter 配置文件 (默认位置为 /etc/taos/taosadapter.toml) 中使能配置项
- 在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
```
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
......@@ -13,11 +14,12 @@ dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...
```
其中 taosAdapter 默认写入的数据库名称为 `icinga2`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。taosAdapter 需重新启动。
其中 taosAdapter 默认写入的数据库名称为 `icinga2`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过 taosAdapter 需重新启动。
或使用 taosAdapter 命令行参数的方式,使能 taosAdapter 接收 icinga2 数据功能。
- 或使用 taosAdapter 命令行参数的方式,使能 taosAdapter 接收 icinga2 数据功能
```
--opentsdb_telnet.dbs strings opentsdb_telnet db names. Env "TAOS_ADAPTER_OPENTSDB_TELNET_DBS" (default [opentsdb_telnet,collectd_tsdb,icinga2_tsdb,tcollector_tsdb])
......@@ -29,8 +31,6 @@ password = "taosdata"
--opentsdb_telnet.user string opentsdb_telnet user. Env "TAOS_ADAPTER_OPENTSDB_TELNET_USER" (default "root")
```
taosAdapter 需重新启动。
### 配置 icinga2
- 使能 icinga2 的 opentsdb-writer(参考链接 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer)
......
### 配置 taosAdapter
taosAdapter 默认使用数据库名称为 statsd ,如需修改数据库名称请停止 taosAdapter 服务并在 taosAdapter 配置文件中修改后重启 taosadapter。
配置 taosAdapter 接收 StatsD 数据的方法:
- 在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
```
...
[statsd]
enable = true
port = 6044
db = "statsd"
user = "root"
password = "taosdata"
worker = 10
gatherInterval = "5s"
protocol = "udp"
maxTCPConnections = 250
tcpKeepAlive = false
allowPendingMessages = 50000
deleteCounters = true
deleteGauges = true
deleteSets = true
deleteTimings = true
...
```
其中 taosAdapter 默认写入的数据库名称为 `statsd`,也可以修改 taosAdapter 配置文件 db 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。
- 也可以使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 StatsD 数据功能
```
--statsd.allowPendingMessages int statsd allow pending messages. Env "TAOS_ADAPTER_STATSD_ALLOW_PENDING_MESSAGES" (default 50000)
--statsd.db string statsd db name. Env "TAOS_ADAPTER_STATSD_DB" (default "statsd")
--statsd.deleteCounters statsd delete counter cache after gather. Env "TAOS_ADAPTER_STATSD_DELETE_COUNTERS" (default true)
--statsd.deleteGauges statsd delete gauge cache after gather. Env "TAOS_ADAPTER_STATSD_DELETE_GAUGES" (default true)
--statsd.deleteSets statsd delete set cache after gather. Env "TAOS_ADAPTER_STATSD_DELETE_SETS" (default true)
--statsd.deleteTimings statsd delete timing cache after gather. Env "TAOS_ADAPTER_STATSD_DELETE_TIMINGS" (default true)
--statsd.enable enable statsd. Env "TAOS_ADAPTER_STATSD_ENABLE" (default true)
--statsd.gatherInterval duration statsd gather interval. Env "TAOS_ADAPTER_STATSD_GATHER_INTERVAL" (default 5s)
--statsd.maxTCPConnections int statsd max tcp connections. Env "TAOS_ADAPTER_STATSD_MAX_TCP_CONNECTIONS" (default 250)
--statsd.password string statsd password. Env "TAOS_ADAPTER_STATSD_PASSWORD" (default "taosdata")
--statsd.port int statsd server port. Env "TAOS_ADAPTER_STATSD_PORT" (default 6044)
--statsd.protocol string statsd protocol [tcp or udp]. Env "TAOS_ADAPTER_STATSD_PROTOCOL" (default "udp")
--statsd.tcpKeepAlive enable tcp keep alive. Env "TAOS_ADAPTER_STATSD_TCP_KEEP_ALIVE"
--statsd.user string statsd user. Env "TAOS_ADAPTER_STATSD_USER" (default "root")
--statsd.worker int statsd write worker. Env "TAOS_ADAPTER_STATSD_WORKER" (default 10)
```
### 配置 StatsD
StatsD 的配置文件请参考其源码根目录下的示例文件 `exampleConfig.js` 进行修改。其中 <taosAdpater's host\> 填写运行 taosAdapter 的服务器域名或 IP 地址,<port for StatsD\>请填写 taosAdapter 接收 StatsD 数据的端口(默认为 6044)。
......
......@@ -3,9 +3,10 @@
配置 taosAdapter 接收 TCollector 数据的方法:
- 在 taosAdapter 配置文件 (默认位置为 /etc/taos/taosadapter.toml) 中使能配置项
- 在 taosAdapter 配置文件(默认位置为 /etc/taos/taosadapter.toml)中使能配置项
```
...
[opentsdb_telnet]
enable = true
maxTCPConnections = 250
......@@ -14,11 +15,12 @@ dbs = ["opentsdb_telnet", "collectd", "icinga2", "tcollector"]
ports = [6046, 6047, 6048, 6049]
user = "root"
password = "taosdata"
...
```
其中 taosAdapter 默认写入的数据库名称为 `tcollector`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。taosAdapter 需重新启动。
其中 taosAdapter 默认写入的数据库名称为 `tcollector`,也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。
或使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 tcollector 数据功能。
- 或使用 taosAdapter 命令行参数或设置环境变量启动的方式,使能 taosAdapter 接收 tcollector 数据功能
```
--opentsdb_telnet.dbs strings opentsdb_telnet db names. Env "TAOS_ADAPTER_OPENTSDB_TELNET_DBS" (default [opentsdb_telnet,collectd_tsdb,icinga2_tsdb,tcollector_tsdb])
......
配置方法,在 `/etc/telegraf/telegraf.conf` 增加 outputs.http 输出模块配置:
在 Telegraf 配置文件(默认为 /etc/telegraf/telegraf.conf) 增加 outputs.http 输出模块配置:
```
[[outputs.http]]
......@@ -12,7 +12,7 @@
其中 <taosAdapter's host\> 请填写运行 taosAdapter 服务的服务器域名或 IP 地址,<REST service port\> 请填写 REST 服务的端口(默认为 6041),<TDengine's username\> 和 <TDengine's password\> 请填写当前运行的 TDengine 实际配置,<database name\> 请填写希望在 TDengine 保存 Telegraf 数据的数据库名。
示例 telegraf.conf 如下:
示例如下:
```
[[outputs.http]]
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册