From 2de121655e248dbba8a6372fa864d40a67d4e456 Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Mon, 18 Apr 2022 17:21:17 +0800 Subject: [PATCH] docs: 3rd parties doc refine (#11591) [TD-14841] --- docs-cn/09-third-party/02-prometheus.md | 13 ++++++++++--- docs-cn/09-third-party/03-telegraf.md | 12 +++++++----- docs-cn/09-third-party/05-collectd.md | 6 ++++-- docs-cn/09-third-party/06-statsd.md | 7 ++++--- docs-cn/09-third-party/07-icinga2.md | 5 +++-- docs-cn/09-third-party/08-tcollector.md | 5 +++-- 6 files changed, 31 insertions(+), 17 deletions(-) diff --git a/docs-cn/09-third-party/02-prometheus.md b/docs-cn/09-third-party/02-prometheus.md index e30c50d67f..a543bde90e 100644 --- a/docs-cn/09-third-party/02-prometheus.md +++ b/docs-cn/09-third-party/02-prometheus.md @@ -1,10 +1,13 @@ --- sidebar_label: Prometheus -title: Prometheus 写入 +title: Prometheus 远端读取/远端写入 --- -remote_read 和 remote_write 是 Prometheus 数据读写分离的集群方案。 -只需要将 remote_read 和 remote_write url 指向 taosAdapter 对应的 url 同时设置 Basic 验证即可使用。 +Prometheus 是一款流行的开源监控告警系统。Prometheus 的 remote_read 和 remote_write 的接口提供监控数据的远端读写的能力。 + +TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 Prometheus 在内的多种应用的数据写入。只需要将 remote_read 和 remote_write url 指向 taosAdapter 对应的 url 同时设置 Basic 验证即可使用。 + +启动 taosAdapter 的命令为 `systemctl start taosadapter`。可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 - remote_read url : `http://host_to_taosAdapter:port(default 6041)/prometheus/v1/remote_read/:db` - remote_write url : `http://host_to_taosAdapter:port(default 6041)/prometheus/v1/remote_write/:db` @@ -31,3 +34,7 @@ remote_read: remote_timeout: 10s read_recent: true ``` + +即可在 TDengine 中查询 metrics 数据库中 Prometheus 写入的数据。 + +taosAdapter 相关配置参数请参考 `taosadapter --help` 命令输出以及相关文档。 diff --git a/docs-cn/09-third-party/03-telegraf.md b/docs-cn/09-third-party/03-telegraf.md index 8b517cdf94..f7e70d7f49 100644 --- a/docs-cn/09-third-party/03-telegraf.md +++ b/docs-cn/09-third-party/03-telegraf.md @@ -3,11 +3,13 @@ sidebar_label: Telegraf title: Telegraf 写入 --- -安装 Telegraf 请参考[官方文档](https://portal.influxdata.com/downloads/)。 +Telegraf 是一款十分流行的指标采集开源软件。安装 Telegraf 请参考[官方文档](https://portal.influxdata.com/downloads/)。 -TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 Telegraf 的多种应用的数据写入。 +TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，可以接收包括 Telegraf 在内的多种应用的数据写入。 -配置方法，在 /etc/telegraf/telegraf.conf 增加如下配置，其中 database name 请填写希望在 TDengine 保存 Telegraf 数据的数据库名，TDengine server、cluster host、username 和 password 填写 TDengine 集群中的实际配置： +启动 taosAdapter 的命令为 `systemctl start taosadapter`。可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 + +配置方法，在 /etc/telegraf/telegraf.conf 增加如下配置，其中 `database name` 请填写希望在 TDengine 保存 Telegraf 数据的数据库名，`TDengine server`、`cluster host`、`username` 和 `password` 填写 TDengine 集群中的实际配置： ``` [[outputs.http]] @@ -23,9 +25,9 @@ TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责 然后重启 telegraf： ``` -sudo systemctl start telegraf +sudo systemctl restart telegraf ``` 即可在 TDengine 中查询 metrics 数据库中 Telegraf 写入的数据。 -taosAdapter 相关配置参数请参考 taosadapter --help 命令输出以及相关文档。 +taosAdapter 相关配置参数请参考 `taosadapter --help` 命令输出以及相关文档。 diff --git a/docs-cn/09-third-party/05-collectd.md b/docs-cn/09-third-party/05-collectd.md index c9c1c04045..e92c1f1ef6 100644 --- a/docs-cn/09-third-party/05-collectd.md +++ b/docs-cn/09-third-party/05-collectd.md @@ -3,9 +3,11 @@ sidebar_label: collectd title: collectd 写入 --- -安装 collectd，请参考[官方文档](https://collectd.org/download.shtml)。 +collectd 是一款插件式架构的开源监控软件，它可以收集各种来源的指标，如操作系统，应用程序，日志文件和外部设备，并存储此信息或通过网络提供。安装 collectd 请参考[官方文档](https://collectd.org/download.shtml)。 -TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 collectd 的多种应用的数据写入。 +TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，可以接收包括 collectd 的多种应用的数据写入。 + +启动 taosAdapter 的命令为 `systemctl start taosadapter`，可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 在 `/etc/collectd/collectd.conf` 文件中增加如下内容，其中 host 和 port 请填写 TDengine 和 taosAdapter 配置的实际值： diff --git a/docs-cn/09-third-party/06-statsd.md b/docs-cn/09-third-party/06-statsd.md index 9b38d95fe4..6c0082da86 100644 --- a/docs-cn/09-third-party/06-statsd.md +++ b/docs-cn/09-third-party/06-statsd.md @@ -3,10 +3,11 @@ sidebar_label: StatsD title: StatsD 直接写入 --- -安装 StatsD -请参考[官方文档](https://github.com/statsd/statsd)。 +StatsD 是汇总和总结应用指标的一个简单的守护进程，近些年来发展迅速，已经变成了一个用于收集应用性能指标的统一的协议。安装 StatsD 请参考[官方文档](https://github.com/statsd/statsd)。 -TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 StatsD 的多种应用的数据写入。 +TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，可以接收包括 StatsD 的多种应用的数据写入。 + +启动 taosAdapter 的命令为 `systemctl start taosadapter`，可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 在 `config.js` 文件中增加如下内容后启动 StatsD，其中 host 和 port 请填写 TDengine 和 taosAdapter 配置的实际值： diff --git a/docs-cn/09-third-party/07-icinga2.md b/docs-cn/09-third-party/07-icinga2.md index 0a37a10ea9..25e8487402 100644 --- a/docs-cn/09-third-party/07-icinga2.md +++ b/docs-cn/09-third-party/07-icinga2.md @@ -3,11 +3,12 @@ sidebar_label: icinga2 title: icinga2 写入 --- -安装 icinga2 -请参考[官方文档](https://icinga.com/docs/icinga-2/latest/doc/02-installation/) +icinga2 是一款开源主机、网络监控软件，最初由 Nagios 网络监控应用发展而来。目前，icinga2 遵从 GNU GPL v2 许可协议发行。安装 icinga2 请参考[官方文档](https://icinga.com/docs/icinga-2/latest/doc/02-installation/) TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 icinga2 的多种应用的数据写入。 +启动 taosAdapter 的命令为 `systemctl start taosadapter`，可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 + icinga2 可以收集监控和性能数据并写入 OpenTSDB，taosAdapter 可以支持接收 icinga2 的数据并写入到 TDengine 中。 - 参考链接 `https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer` 使能 opentsdb-writer diff --git a/docs-cn/09-third-party/08-tcollector.md b/docs-cn/09-third-party/08-tcollector.md index ba56fb1dc1..6d449b59eb 100644 --- a/docs-cn/09-third-party/08-tcollector.md +++ b/docs-cn/09-third-party/08-tcollector.md @@ -3,11 +3,12 @@ sidebar_label: TCollector title: TCollector 写入 --- -安装 TCollector -请参考[官方文档](http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html#installation-of-tcollector) +TCollector 是 openTSDB 的一部分，它用来采集客户端日志发送给数据库。安装 TCollector 请参考[官方文档](http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html#installation-of-tcollector) TDengine 新版本（2.4.0.0+）包含一个 taosAdapter 独立程序，负责接收包括 TCollector 的多种应用的数据写入。 +启动 taosAdapter 的命令为 `systemctl start taosadapter`，可以使用 `systemctl status taosadapter` 检查 taosAdapter 的运行状态。 + TCollector 是一个在客户侧收集本地收集器并发送数据到 OpenTSDB 的进程，taosAdapter 可以支持接收 TCollector 的数据并写入到 TDengine 中。 使能 taosAdapter 配置项 `opentsdb_telnet.enable` -- GitLab