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

docs: 3rd parties docs refine (#11722)

* 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]
上级 5ed15915
...@@ -11,14 +11,12 @@ Prometheus 提供了 `remote_write` 和 `remote_read` 接口来利用其它数 ...@@ -11,14 +11,12 @@ Prometheus 提供了 `remote_write` 和 `remote_read` 接口来利用其它数
通过适当的配置, Prometheus 的数据可以通过 `remote_write` 接口存储到 TDengine 中,也可以通过 `remote_read` 接口来查询存储在 TDengine 中的数据,充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 通过适当的配置, Prometheus 的数据可以通过 `remote_write` 接口存储到 TDengine 中,也可以通过 `remote_read` 接口来查询存储在 TDengine 中的数据,充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 Prometheus 请参考[官方文档](https://prometheus.io/docs/prometheus/latest/installation/)
## 前置条件 ## 前置条件
要将 Prometheus 数据写入 TDengine, 需要几方面的准备工作。 要将 Prometheus 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- Prometheus 已经安装 - Prometheus 已经安装。安装 Prometheus 请参考[官方文档](https://prometheus.io/docs/prometheus/latest/installation/)
## 配置 Prometheus ## 配置 Prometheus
<Prometheus /> <Prometheus />
......
...@@ -9,14 +9,12 @@ Telegraf 是一款十分流行的指标采集开源软件。在数据采集和 ...@@ -9,14 +9,12 @@ Telegraf 是一款十分流行的指标采集开源软件。在数据采集和
只需要将 Telegraf 的配置修改指向 taosAdapter 对应的 url 并修改若干配置项即可将 Telegraf 的数据写入到 TDengine 中。将 Telegraf 的数据存在到 TDengine 中可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 只需要将 Telegraf 的配置修改指向 taosAdapter 对应的 url 并修改若干配置项即可将 Telegraf 的数据写入到 TDengine 中。将 Telegraf 的数据存在到 TDengine 中可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 Telegraf 请参考[官方文档](https://docs.influxdata.com/telegraf/v1.22/install/)
## 前置条件 ## 前置条件
要将 Telegraf 数据写入 TDengine, 需要几方面的准备工作。 要将 Telegraf 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- Telegraf 已经安装 - Telegraf 已经安装。安装 Telegraf 请参考[官方文档](https://docs.influxdata.com/telegraf/v1.22/install/)
## 配置 Telegraf ## 配置 Telegraf
<Telegraf /> <Telegraf />
......
...@@ -5,18 +5,16 @@ title: collectd 写入 ...@@ -5,18 +5,16 @@ title: collectd 写入
import CollectD from "../14-reference/_collectd.mdx" import CollectD from "../14-reference/_collectd.mdx"
collectd 是一款插件式架构的开源监控软件,它可以收集各种来源的指标,如操作系统,应用程序,日志文件和外部设备,并存储此信息或通过网络提供 collectd 是一个守护进程,用来收集系统性能和提供各种存储方式来存储不同值的机制。它会在系统运行和存储信息时周期性的统计系统的相关统计信息。利用这些信息有助于查找当前系统性能瓶颈和预测系统未来的负载等
只需要将 collectd 的配置指向 taosAdapter 对应的服务器和端口即可将 collectd 采集的数据写入到 TDengine,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 只需要将 collectd 的配置指向运行 taosAdapter 的服务器域名(或 IP 地址)和相应端口即可将 collectd 采集的数据写入到 TDengine,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 collectd 请参考[官方文档](https://collectd.org/download.shtml)
## 前置条件 ## 前置条件
要将 collectd 数据写入 TDengine, 需要几方面的准备工作。 要将 collectd 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- collectd 已经安装 - collectd 已经安装。安装 collectd 请参考[官方文档](https://collectd.org/download.shtml)
## 配置 collectd ## 配置 collectd
<CollectD /> <CollectD />
......
...@@ -7,16 +7,14 @@ import StatsD from "../14-reference/_statsd.mdx" ...@@ -7,16 +7,14 @@ import StatsD from "../14-reference/_statsd.mdx"
StatsD 是汇总和总结应用指标的一个简单的守护进程,近些年来发展迅速,已经变成了一个用于收集应用性能指标的统一的协议。 StatsD 是汇总和总结应用指标的一个简单的守护进程,近些年来发展迅速,已经变成了一个用于收集应用性能指标的统一的协议。
只需要将 StatsD 的配置修改指向 taosAdapter 对应的服务器地址和端口接口即可将 StatsD 的数据写入到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 只需要在 StatsD 的配置文件中填写运行 taosAdapter 的服务器域名(或 IP 地址)和相应端口即可将 StatsD 的数据写入到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 StatsD 请参考[官方文档](https://github.com/statsd/statsd)
## 前置条件 ## 前置条件
要将 StatsD 数据写入 TDengine, 需要几方面的准备工作。 要将 StatsD 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装并正在运行, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装并正在运行具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- StatsD 已经安装 - StatsD 已经安装。安装 StatsD 请参考[官方文档](https://github.com/statsd/statsd)
## 配置 StatsD ## 配置 StatsD
<StatsD /> <StatsD />
......
...@@ -7,25 +7,23 @@ import Icinga2 from "../14-reference/_icinga2.mdx" ...@@ -7,25 +7,23 @@ import Icinga2 from "../14-reference/_icinga2.mdx"
icinga2 是一款开源主机、网络监控软件,最初由 Nagios 网络监控应用发展而来。目前,icinga2 遵从 GNU GPL v2 许可协议发行。 icinga2 是一款开源主机、网络监控软件,最初由 Nagios 网络监控应用发展而来。目前,icinga2 遵从 GNU GPL v2 许可协议发行。
只需要将 icinga2 的配置修改指向 taosAdapter 对应的服务器和端口即可将 icinga2 采集的数据存在到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 只需要将 icinga2 的配置修改指向 taosAdapter 对应的服务器和相应端口即可将 icinga2 采集的数据存在到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 icinga2 请参考[官方文档](https://icinga.com/docs/icinga-2/latest/doc/02-installation/)
## 前置条件 ## 前置条件
要将 icinga2 数据写入 TDengine, 需要几方面的准备工作。 要将 icinga2 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装但并未运行,或停止在运行中的 taosAdapter ,修改完配置文件再运行。具体细节请参考[ taosAdapter 的使用手册](/reference/taosadapter)
- icinga2 已经安装 - icinga2 已经安装且并未运行,或停止在运行中的 icinga2 ,修改完配置文件再重新运行。安装 icinga2 请参考[官方文档](https://icinga.com/docs/icinga-2/latest/doc/02-installation/)
## 配置 icinga2 ## 配置 icinga2
<Icinga2 /> <Icinga2 />
## 验证方法 ## 验证方法
使用 `systemctl restart taosadapter` 重启 taosAdapter。 使用 `systemctl start taosadapter` 启动 taosAdapter。
使用 `systemctl restart icinga2` 重启 icinga2。 使用 `systemctl start icinga2` 启动 icinga2。
等待 10 秒左右后,使用 TDengine CLI 查询 TDengine 是否创建相应数据库并写入数据。 等待 10 秒左右后,使用 TDengine CLI 查询 TDengine 验证是否创建相应数据库并写入数据。
``` ```
taos> show databases; taos> show databases;
......
...@@ -7,23 +7,21 @@ import Tcollector from "../14-reference/_tcollector.mdx" ...@@ -7,23 +7,21 @@ import Tcollector from "../14-reference/_tcollector.mdx"
TCollector 是 openTSDB 的一部分,它用来采集客户端日志发送给数据库。 TCollector 是 openTSDB 的一部分,它用来采集客户端日志发送给数据库。
只需要将 TCollect 的配置修改指向 taosAdapter 对应的服务器和端口即可将 icinga2 采集的数据存在到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。 只需要将 TCollector 的配置修改指向运行 taosAdapter 的服务器域名(或 IP 地址)和相应端口即可将 TCollector 采集的数据存在到 TDengine 中,可以充分利用 TDengine 对时序数据的高效存储查询性能和集群处理能力。
安装 TCollector 请参考[官方文档](http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html#installation-of-tcollector)
## 前置条件 ## 前置条件
要将 TCollect 数据写入 TDengine, 需要几方面的准备工作。 要将 TCollector 数据写入 TDengine, 需要几方面的准备工作。
- TDengine 集群已经部署并正在运行 - TDengine 集群已经部署并正在运行
- taosAdapter 已经安装, 具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) - taosAdapter 已经安装但并未运行,或者停止正在运行中的 taosAdapter,修改完配置文件再运行。具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter)
- TCollect 已经安装 - TCollector 已经安装且并未运行,或者停止正在运行中的 TCollector ,修改完配置文件再运行。安装 TCollector 请参考[官方文档](http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html#installation-of-tcollector)
## 配置 TCollector ## 配置 TCollector
<Tcollector /> <Tcollector />
## 验证方法 ## 验证方法
手动执行 sudo ./tcollector.py 后使用 TDengine CLI 查询 TDengine 是否创建相应数据库并写入数据。 手动执行 `sudo ./tcollector.py` 后使用 TDengine CLI 查询 TDengine 是否创建相应数据库并写入数据。
``` ```
taos> show databases; taos> show databases;
......
taosAdapter 默认使用数据库名称为 collectd,如需修改数据库名称请停止 taosAdapter 服务并在 taosAdapter 配置文件中修改后重启 taosadapter。
collectd 使用插件机制可以以多种形式将采集到的监控数据写入到不同的数据存储软件。TDengine 支持直接采集插件和 write_tsdb 插件。 collectd 使用插件机制可以以多种形式将采集到的监控数据写入到不同的数据存储软件。TDengine 支持直接采集插件和 write_tsdb 插件。
### 配置接收直接采集插件数据 ### 配置接收直接采集插件数据
修改 collectd 配置文件 `/etc/collectd/collectd.conf` 配置项taosAdapter 默认使用端口 6045 来接收 collectd 直接采集插件的数据。 修改 collectd 配置文件 `/etc/collectd/collectd.conf` 配置项。其中 <taosAdapter's host> 填写运行 taosAdapter 的服务器域名或 IP 地址。taosAdapter 默认使用端口 6045 来接收 collectd 直接采集插件的数据。
```text ```text
LoadPlugin network LoadPlugin network
<Plugin network> <Plugin network>
Server "<taosAdapter host>" "6045" Server "<taosAdapter's host>" "6045"
</Plugin> </Plugin>
``` ```
### 配置 write_tsdb 插件数据 ### 配置 write_tsdb 插件数据
修改 collectd 配置文件 `/etc/collectd/collectd.conf` 配置项,taosAdapter 默认使用端口 6047 来接收 collectd write_tsdb 插件的数据。 修改 collectd 配置文件 `/etc/collectd/collectd.conf` 配置项,其中 <taosAdapter's host> 填写运行 taosAdapter 的服务器域名或 IP 地址。taosAdapter 默认使用端口 6047 来接收 collectd write_tsdb 插件的数据。
```text ```text
LoadPlugin write_tsdb LoadPlugin write_tsdb
<Plugin write_tsdb> <Plugin write_tsdb>
<Node> <Node>
Host "<taosAdapter host>" Host "<taosAdapter's host>"
Port "6047" Port "6047"
HostTags "status=production" HostTags "status=production"
StoreRates false StoreRates false
......
配置 taosAdapter 接收 icinga2 数据的方法: 配置 taosAdapter 接收 icinga2 数据的方法:
- 参考链接 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer 使能 opentsdb-writer - 使能 icinga2 的 opentsdb-writer(参考链接 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer)
- 使能 taosAdapter 配置文件 /etc/taos/taosadapter.toml 中配置项 opentsdb_telnet.enable - 通过修改配置文件 `/etc/taos/taosadapter.toml` 的配置项 `opentsdb_telnet.enable=True`,或使用 taosAdapter 命令行参数的方式,使能 taosAdapter 接收 icinga2 数据功能。taosAdapter 默认写入数据库名称为 icinga2,如果需要指定不同的数据库名称可以在 taosAdapter 配置文件中修改。taosAdapter 需重新启动
- 修改配置文件 /etc/icinga2/features-enabled/opentsdb.conf - 修改配置文件 `/etc/icinga2/features-enabled/opentsdb.conf` 填写 <taosAdapter's host> 为运行 taosAdapter 的服务器的域名或 IP 地址,port 填写 taosAdapter 支持接收 icinga2 数据的相应端口(默认为 6048)
``` ```
object OpenTsdbWriter "opentsdb" { object OpenTsdbWriter "opentsdb" {
host = "host to taosAdapter" host = "<taosAdapter's host>"
port = 6048 port = 6048
} }
``` ```
......
...@@ -2,17 +2,17 @@ ...@@ -2,17 +2,17 @@
### 配置第三方数据库地址 ### 配置第三方数据库地址
将其中的 remote_read 和 remote_write 指向 taosAdapter 的正确地址,并确保 相应的 URL 配置如下 将其中的 remote_read url 和 remote_write url 指向运行 taosAdapter 服务的服务器域名或 IP 地址,REST 服务端口(taosAdapter 默认使用 6041),以及希望写入 TDengine 的数据库名称,并确保相应的 URL 形式如下:
- remote_read url : `http://host_to_taosAdapter:port(default 6041)/prometheus/v1/remote_read/:db` - remote_read url : `http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_read/<database name>`
- remote_write url : `http://host_to_taosAdapter:port(default 6041)/prometheus/v1/remote_write/:db` - remote_write url : `http://<taosAdapter's host>:<REST service port>/prometheus/v1/remote_write/<database name>`
### 配置 Basic 验证 ### 配置 Basic 验证
- username: TDengine 连接用户名 - username: <TDengine's username>
- password: TDengine 连接密码 - password: <TDengine's password>
### 示例 ### prometheus.yml 文件中 remote_write 和 remote_read 相关部分配置示例
```yaml ```yaml
remote_write: remote_write:
......
在 `config.js` 文件中增加如下内容后启动 StatsD,其中 `taosAdapter host` 和 `port` 请填写 taosAdapter 配置的实际值: taosAdapter 默认使用数据库名称为 statsd ,如需修改数据库名称请停止 taosAdapter 服务并在 taosAdapter 配置文件中修改后重启 taosadapter。
在 `config.js` 文件中增加如下内容后启动 StatsD,其中 <taosAdapter's host> 和 <port for StatsD> 请填写 taosAdapter 配置的实际值(默认为 6044):
``` ```
backends 部分添加 "./backends/repeater" backends 部分添加 "./backends/repeater"
repeater 部分添加 { host:'<taosAdapter host>', port: <port for StatsD>} repeater 部分添加 { host:'<taosAdapter's host>', port: <port for StatsD>}
``` ```
示例配置文件: 示例配置文件:
......
配置 taosAdapter 接收 TCollector 数据的方法: 配置 taosAdapter 接收 TCollector 数据的方法:
- 使能 taosAdapter 配置项 `opentsdb_telnet.enable` - 在 taosAdapter 配置文件 taosadapter.yaml 中使能配置项 `opentsdb_telnet.enable=True`。taosAdapter 默认写入的数据库名称为 `tcollector`,也可以修改 taosAdapter 配置文件来指定不同的名称。
- 修改 TCollector 配置文件,修改 OpenTSDB 宿主机地址为 taosAdapter 被部署的地址,并修改端口号为 taosAdapter 使用的端口(默认 6049)。注意:TCollector 各个版本变化较大,以 master 分支代码为例,需要修改 collectors/etc/config.py 和 tcollector.py 中相应设置。其他版本需要修改的文件可能有所不同。 - 修改 TCollector 配置项,将 OpenTSDB 宿主机地址修改为 taosAdapter 被部署的服务器域名或 IP 地址,修改端口号为 taosAdapter 支持 TCollector 使用的相应端口(默认为 6049)。注意:TCollector 各个版本变化较大,以 master 分支代码为例,需要修改 `collectors/etc/config.py` 和 `tcollector.py` 两个文件中相应内容。其他版本需要修改的文件可能有所不同。
配置方法,在 `/etc/telegraf/telegraf.conf` 增加如下配置,其中 `database name` 请填写希望在 TDengine 保存 Telegraf 数据的数据库名,`taosAdapter host`、`username` 和 `password` 填写 taosAdapter 服务的实际配置: 配置方法,在 `/etc/telegraf/telegraf.conf` 增加如下配置,其中 <taosAdapter's host> 请填写运行 taosAdapter 服务的服务器域名或 IP 地址,<REST service port> 请填写 REST 服务的端口(默认为 6041),<TDengine's username> 和 <TDengine's password> 请填写当前运行的 TDengine 实际配置,<database name> 请填写希望在 TDengine 保存 Telegraf 数据的数据库名。
示例 telegraf.conf 如下: 示例 telegraf.conf 如下:
``` ```
[[outputs.http]] [[outputs.http]]
url = "http://<taosAdapter host>:6041/influxdb/v1/write?db=<database name>" url = "http://<taosAdapter's host>:<REST service port>/influxdb/v1/write?db=<database name>"
method = "POST" method = "POST"
timeout = "5s" timeout = "5s"
username = "<TDengine's username>" username = "<TDengine's username>"
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册