From e62f0d12f3ba09343c9a2ff8baa8e3a88a67767f Mon Sep 17 00:00:00 2001 From: t_max <1172915550@qq.com> Date: Wed, 5 Feb 2025 17:47:55 +0800 Subject: [PATCH] docs: update taosAdapter doc --- docs/en/assets/resources/_collectd.mdx | 86 +++++++++---------- docs/en/assets/resources/_icinga2.mdx | 26 +++--- .../14-reference/01-components/_collectd.mdx | 86 +++++++++---------- .../14-reference/01-components/_icinga2.mdx | 26 +++--- 4 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/en/assets/resources/_collectd.mdx b/docs/en/assets/resources/_collectd.mdx index 5fc09a919f..c39950e4f3 100644 --- a/docs/en/assets/resources/_collectd.mdx +++ b/docs/en/assets/resources/_collectd.mdx @@ -27,58 +27,58 @@ collectd uses a plugin mechanism that can write the collected monitoring data to 1. **Configuring to receive direct collection plugin data** -Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). + Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). -```xml -LoadPlugin network - - Server "" "" - -``` + ```xml + LoadPlugin network + + Server "" "" + + ``` -Where \ should be filled with the domain name or IP address of the server running taosAdapter. \ should be filled with the port used by taosAdapter to receive collectd data (default is 6045). + Where \ should be filled with the domain name or IP address of the server running taosAdapter. \ should be filled with the port used by taosAdapter to receive collectd data (default is 6045). -Example as follows: + Example as follows: -```xml -LoadPlugin network - - Server "127.0.0.1" "6045" - -``` + ```xml + LoadPlugin network + + Server "127.0.0.1" "6045" + + ``` 2. **Configuring write_tsdb plugin data** -Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). + Modify the related configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). -```xml -LoadPlugin write_tsdb - - - Host "" - Port "" - ... - - -``` + ```xml + LoadPlugin write_tsdb + + + Host "" + Port "" + ... + + + ``` -Where \ should be filled with the domain name or IP address of the server running taosAdapter. \ should be filled with the port used by taosAdapter to receive collectd write_tsdb plugin data (default is 6047). + Where \ should be filled with the domain name or IP address of the server running taosAdapter. \ should be filled with the port used by taosAdapter to receive collectd write_tsdb plugin data (default is 6047). -```xml -LoadPlugin write_tsdb - - - Host "127.0.0.1" - Port "6047" - HostTags "status=production" - StoreRates false - AlwaysAppendDS false - - -``` + ```xml + LoadPlugin write_tsdb + + + Host "127.0.0.1" + Port "6047" + HostTags "status=production" + StoreRates false + AlwaysAppendDS false + + + ``` -Then restart collectd: + Then restart collectd: -```shell -systemctl restart collectd -``` + ```shell + systemctl restart collectd + ``` diff --git a/docs/en/assets/resources/_icinga2.mdx b/docs/en/assets/resources/_icinga2.mdx index 09cb90ef0c..4f8ba7c3c4 100644 --- a/docs/en/assets/resources/_icinga2.mdx +++ b/docs/en/assets/resources/_icinga2.mdx @@ -26,18 +26,18 @@ Method to configure taosAdapter to receive icinga2 data: - 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 \ with the domain name or IP address of the server running taosAdapter, \ with the corresponding port supported by taosAdapter for receiving icinga2 data (default is 6048) -```c -object OpenTsdbWriter "opentsdb" { - host = "" - port = -} -``` + ```c + object OpenTsdbWriter "opentsdb" { + host = "" + port = + } + ``` -Example file: + Example file: -```c -object OpenTsdbWriter "opentsdb" { - host = "127.0.0.1" - port = 6048 -} -``` + ```c + object OpenTsdbWriter "opentsdb" { + host = "127.0.0.1" + port = 6048 + } + ``` diff --git a/docs/zh/14-reference/01-components/_collectd.mdx b/docs/zh/14-reference/01-components/_collectd.mdx index f2a35c61de..5861e0aab4 100644 --- a/docs/zh/14-reference/01-components/_collectd.mdx +++ b/docs/zh/14-reference/01-components/_collectd.mdx @@ -27,59 +27,59 @@ collectd 使用插件机制可以以多种形式将采集到的监控数据写 1. **配置直接采集插件** -修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 + 修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 -```xml -LoadPlugin network - - Server "" "" - -``` + ```xml + LoadPlugin network + + Server "" "" + + ``` -其中 \ 填写运行 taosAdapter 的服务器域名或 IP 地址。\ 填写 taosAdapter 用于接收 collectd 数据的端口（默认为 6045）。 + 其中 \ 填写运行 taosAdapter 的服务器域名或 IP 地址。\ 填写 taosAdapter 用于接收 collectd 数据的端口（默认为 6045）。 -示例如下： + 示例如下： -```xml -LoadPlugin network - - Server "127.0.0.1" "6045" - -``` + ```xml + LoadPlugin network + + Server "127.0.0.1" "6045" + + ``` 2. **配置 write_tsdb 插件** -修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 + 修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 -```xml -LoadPlugin write_tsdb - - - Host "" - Port "" - ... - - -``` + ```xml + LoadPlugin write_tsdb + + + Host "" + Port "" + ... + + + ``` -其中 \ 填写运行 taosAdapter 的服务器域名或 IP 地址。\ 填写 taosAdapter 用于接收 collectd write_tsdb 插件的数据（默认为 6047）。 + 其中 \ 填写运行 taosAdapter 的服务器域名或 IP 地址。\ 填写 taosAdapter 用于接收 collectd write_tsdb 插件的数据（默认为 6047）。 -```xml -LoadPlugin write_tsdb - - - Host "127.0.0.1" - Port "6047" - HostTags "status=production" - StoreRates false - AlwaysAppendDS false - - -``` + ```xml + LoadPlugin write_tsdb + + + Host "127.0.0.1" + Port "6047" + HostTags "status=production" + StoreRates false + AlwaysAppendDS false + + + ``` -然后重启 collectd： + 然后重启 collectd： -```shell -systemctl restart collectd -``` + ```shell + systemctl restart collectd + ``` diff --git a/docs/zh/14-reference/01-components/_icinga2.mdx b/docs/zh/14-reference/01-components/_icinga2.mdx index 9d6d9bc780..360537fead 100644 --- a/docs/zh/14-reference/01-components/_icinga2.mdx +++ b/docs/zh/14-reference/01-components/_icinga2.mdx @@ -26,19 +26,19 @@ - 使能 icinga2 的 opentsdb-writer（参考链接 https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer） - 修改配置文件 `/etc/icinga2/features-enabled/opentsdb.conf` 填写 \ 为运行 taosAdapter 的服务器的域名或 IP 地址，\ 填写 taosAdapter 支持接收 icinga2 数据的相应端口（默认为 6048） -```c -object OpenTsdbWriter "opentsdb" { - host = "" - port = -} -``` + ```c + object OpenTsdbWriter "opentsdb" { + host = "" + port = + } + ``` -示例文件： + 示例文件： -```c -object OpenTsdbWriter "opentsdb" { - host = "127.0.0.1" - port = 6048 -} -``` + ```c + object OpenTsdbWriter "opentsdb" { + host = "127.0.0.1" + port = 6048 + } + ```