From 72d8fcec13c6bdd8d4d76b9745079934de81c3f8 Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Sun, 15 May 2022 14:09:57 +0800 Subject: [PATCH] docs: 3rd parties in english (#12501) * docs: 3rd parties doc in English [TD-15558] * fix link to broder * docs: third parties doc in English [TD-15558] * docs: 3rd parties doc in English translate reference doc --- docs-cn/14-reference/_collectd.mdx | 2 +- docs-cn/14-reference/_icinga2.mdx | 2 +- docs-en/14-reference/_collectd.mdx | 37 ++++++++++++++-------------- docs-en/14-reference/_icinga2.mdx | 22 +++++++++-------- docs-en/14-reference/_prometheus.mdx | 2 +- docs-en/14-reference/_statsd.mdx | 26 +++++++++---------- docs-en/14-reference/_tcollector.mdx | 19 +++++++------- docs-en/14-reference/_telegraf.mdx | 6 ++--- 8 files changed, 58 insertions(+), 58 deletions(-) diff --git a/docs-cn/14-reference/_collectd.mdx b/docs-cn/14-reference/_collectd.mdx index 1853769bf9..af3388f680 100644 --- a/docs-cn/14-reference/_collectd.mdx +++ b/docs-cn/14-reference/_collectd.mdx @@ -38,7 +38,7 @@ LoadPlugin network 其中 填写运行 taosAdapter 的服务器域名或 IP 地址。 填写 taosAdapter 用于接收 collectd 数据的端口（默认为 6045）。 -实例如下： +示例如下： ```text LoadPlugin network diff --git a/docs-cn/14-reference/_icinga2.mdx b/docs-cn/14-reference/_icinga2.mdx index 0ed5023f95..fdb341e264 100644 --- a/docs-cn/14-reference/_icinga2.mdx +++ b/docs-cn/14-reference/_icinga2.mdx @@ -33,7 +33,7 @@ object OpenTsdbWriter "opentsdb" { } ``` -实例文件： +示例文件： ``` object OpenTsdbWriter "opentsdb" { diff --git a/docs-en/14-reference/_collectd.mdx b/docs-en/14-reference/_collectd.mdx index 1853769bf9..af3dd7564a 100644 --- a/docs-en/14-reference/_collectd.mdx +++ b/docs-en/14-reference/_collectd.mdx @@ -1,8 +1,8 @@ -### 配置 taosAdapter +### Configuring taosAdapter -配置 taosAdapter 接收 collectd 数据的方法： +To configure taosAdapter to receive collectd data. -- 在 taosAdapter 配置文件（默认位置为 /etc/taos/taosadapter.toml）中使能配置项 +- Enable the configuration item in the taosAdapter configuration file (default location is /etc/taos/taosadapter.toml) ``` ... @@ -17,17 +17,17 @@ password = "taosdata" ... ``` -其中 taosAdapter 默认写入的数据库名称为 `collectd`，也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 +The default database name written by taosAdapter is `collectd`. You can also modify the taosAdapter configuration file dbs entry to specify a different name. user and password are the values configured by the actual TDengine. After changing the configuration file, you need to restart the taosAdapter. -- 也可以使用 taosAdapter 命令行参数或设置环境变量启动的方式，使能 taosAdapter 接收 collectd 数据功能，具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) +- You can also enable the taosAdapter to receive collectd data by using the taosAdapter command line parameters or by setting environment variables. -### 配置 collectd -# -collectd 使用插件机制可以以多种形式将采集到的监控数据写入到不同的数据存储软件。TDengine 支持直接采集插件和 write_tsdb 插件。 +### Configure collectd +#collectd +collectd uses a plugin mechanism to write the collected monitoring data to different data storage software in various forms. tdengine supports both direct collection plugins and write_tsdb plugins. -#### 配置接收直接采集插件数据 +#### is configured to receive data from the direct collection plugin -修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 +Modify the relevant configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). ```text LoadPlugin network @@ -36,20 +36,20 @@ LoadPlugin network ``` -其中 填写运行 taosAdapter 的服务器域名或 IP 地址。 填写 taosAdapter 用于接收 collectd 数据的端口（默认为 6045）。 +where fills in the server's domain name or IP address running taosAdapter. fills in the port that taosAdapter uses to receive collectd data (default is 6045). -实例如下： +An example is as follows. ```text LoadPlugin network - + ``` -#### 配置 write_tsdb 插件数据 +#### Configure write_tsdb plugin data -修改 collectd 配置文件（默认位置 /etc/collectd/collectd.conf）相关配置项。 +Modify the relevant configuration items in the collectd configuration file (default location /etc/collectd/collectd.conf). ```text LoadPlugin write_tsdb @@ -62,7 +62,7 @@ LoadPlugin write_tsdb ``` -其中 填写运行 taosAdapter 的服务器域名或 IP 地址。 填写 taosAdapter 用于接收 collectd write_tsdb 插件的数据（默认为 6047）。 +Where fills in the server's domain name or IP address running taosAdapter. Fill in the data that taosAdapter uses to receive the collectd write_tsdb plugin (default is 6047). ```text LoadPlugin write_tsdb @@ -73,13 +73,12 @@ LoadPlugin write_tsdb HostTags "status=production" StoreRates false AlwaysAppendDS false - + ``` -然后重启 collectd： +Then restart collectd. ``` systemctl restart collectd ``` - diff --git a/docs-en/14-reference/_icinga2.mdx b/docs-en/14-reference/_icinga2.mdx index 0ed5023f95..a6d3bb71f9 100644 --- a/docs-en/14-reference/_icinga2.mdx +++ b/docs-en/14-reference/_icinga2.mdx @@ -1,8 +1,10 @@ -### 配置 taosAdapter -配置 taosAdapter 接收 icinga2 数据的方法： -- 在 taosAdapter 配置文件（默认位置 /etc/taos/taosadapter.toml）中使能配置项 +### Configuring taosAdapter + +To configure taosAdapter to receive icinga2 data. + +- Enable the configuration item in the taosAdapter configuration file (default location /etc/taos/taosadapter.toml) ``` ... @@ -17,23 +19,23 @@ password = "taosdata" ... ``` -其中 taosAdapter 默认写入的数据库名称为 `icinga2`，也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过 taosAdapter 需重新启动。 +The default database name written by the taosAdapter is `icinga2`. You can also modify the taosAdapter configuration file dbs entry to specify a different name. user and password are the values configured by the actual TDengine. You need to restart the taosAdapter after modification. -- 也可以使用 taosAdapter 命令行参数或设置环境变量启动的方式，使能 taosAdapter 接收 icinga2 数据功能，具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) +- You can also enable taosAdapter to receive icinga2 data by using the taosAdapter command line parameters or setting environment variables. -### 配置 icinga2 +### Configure icinga3 -- 使能 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） +- Enable opentsdb-writer for icinga2 (refer to the link https://icinga.com/docs/icinga-2/latest/doc/14-features/#opentsdb-writer) +- Modify the configuration file `/etc/icinga2/features-enabled/opentsdb.conf` by filling in as the domain name or IP address of the server running taosAdapter and as the corresponding port on which taosAdapter supports receiving icinga2 data (default is 6048) -``` +ðŸ™' ðŸ™' object OpenTsdbWriter "opentsdb" { host = "" port = } ``` -实例文件： +Example file: ``` object OpenTsdbWriter "opentsdb" { diff --git a/docs-en/14-reference/_prometheus.mdx b/docs-en/14-reference/_prometheus.mdx index be73d95cbc..99fd95749c 100644 --- a/docs-en/14-reference/_prometheus.mdx +++ b/docs-en/14-reference/_prometheus.mdx @@ -2,7 +2,7 @@ ### 配置第三方数据库地址 -将其中的 remote_read url 和 remote_write url 指向运行 taosAdapter 服务的服务器域名或 IP 地址，REST 服务端口（taosAdapter 默认使用 6041），以及希望写入 TDengine 的数据库名称，并确保相应的 URL 形式如下： +将其中的 `remote_read url` 和 `remote_write url` 指向运行 taosAdapter 服务的服务器域名或 IP 地址，REST 服务端口（taosAdapter 默认使用 6041），以及希望写入 TDengine 的数据库名称，并确保相应的 URL 形式如下： - remote_read url : `http://:/prometheus/v1/remote_read/` - remote_write url : `http://:/prometheus/v1/remote_write/` diff --git a/docs-en/14-reference/_statsd.mdx b/docs-en/14-reference/_statsd.mdx index b225c44267..7077f770fa 100644 --- a/docs-en/14-reference/_statsd.mdx +++ b/docs-en/14-reference/_statsd.mdx @@ -1,8 +1,8 @@ -### 配置 taosAdapter +### Configuring taosAdapter -配置 taosAdapter 接收 StatsD 数据的方法： +To configure taosAdapter to receive StatsD data. -- 在 taosAdapter 配置文件（默认位置 /etc/taos/taosadapter.toml）中使能配置项 +- Enable the configuration item in the taosAdapter configuration file (default location /etc/taos/taosadapter.toml) ``` ... @@ -25,30 +25,30 @@ deleteTimings = true ... ``` -其中 taosAdapter 默认写入的数据库名称为 `statsd`，也可以修改 taosAdapter 配置文件 db 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 +The default database name written by taosAdapter is `statsd`. To specify a different name, you can also modify the taosAdapter configuration file db entry. user and password fill in the actual TDengine configuration values. After changing the configuration file, you need to restart the taosAdapter. -- 也可以使用 taosAdapter 命令行参数或设置环境变量启动的方式，使能 taosAdapter 接收 StatsD 数据功能，具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) +- You can also enable taosAdapter to receive StatsD data by using the taosAdapter command line parameters or setting environment variables. -### 配置 StatsD +### Configuring StatsD -使用 StatsD 需要下载其[源代码](https://github.com/statsd/statsd)。其配置文件请参考其源代码下载到本地的根目录下的示例文件 `exampleConfig.js` 进行修改。其中 填写运行 taosAdapter 的服务器域名或 IP 地址，请填写 taosAdapter 接收 StatsD 数据的端口（默认为 6044）。 +To use StatsD, you need to download its [source code](https://github.com/statsd/statsd). Please refer to the example file `exampleConfig.js` in the root directory of the source download to modify the configuration file. In , please fill in the domain name or IP address of the server running taosAdapter, and , please fill in the port where taosAdapter receives StatsD data (default is 6044). -``` -backends 部分添加 "./backends/repeater" -repeater 部分添加 { host:'', port: } +ðŸ™' ðŸ™' +backends section add ". /backends/repeater" +Add { host:'', port: } to repeater section ``` -示例配置文件： +Example configuration file. ``` { port: 8125 -, backends: ["./backends/repeater"] +, backends: [". /backends/repeater"] , repeater: [{ host: '127.0.0.1', port: 6044}] } ``` -增加如下内容后启动 StatsD（假设配置文件修改为 config.js）。 +Start StatsD after adding the following (assuming the config file is modified to config.js) ``` node stats.js config.js & diff --git a/docs-en/14-reference/_tcollector.mdx b/docs-en/14-reference/_tcollector.mdx index 8e51975b51..b96c981b42 100644 --- a/docs-en/14-reference/_tcollector.mdx +++ b/docs-en/14-reference/_tcollector.mdx @@ -1,9 +1,8 @@ +### Configuring taosAdapter -### 配置 taosAdapter +To configure taosAdapter to receive TCollector data. -配置 taosAdapter 接收 TCollector 数据的方法： - -- 在 taosAdapter 配置文件（默认位置 /etc/taos/taosadapter.toml）中使能配置项 +- Enable the configuration item in the taosAdapter configuration file (default location /etc/taos/taosadapter.toml) ``` ... @@ -18,17 +17,17 @@ password = "taosdata" ... ``` -其中 taosAdapter 默认写入的数据库名称为 `tcollector`，也可以修改 taosAdapter 配置文件 dbs 项来指定不同的名称。user 和 password 填写实际 TDengine 配置的值。修改过配置文件 taosAdapter 需重新启动。 +The taosAdapter writes to the database with the default name `tcollector`. You can also modify the taosAdapter configuration file dbs entry to specify a different name. user and password fill in the actual TDengine configuration values. After changing the configuration file, you need to restart the taosAdapter. -- 也可以使用 taosAdapter 命令行参数或设置环境变量启动的方式，使能 taosAdapter 接收 tcollector 数据功能，具体细节请参考 [taosAdapter 的使用手册](/reference/taosadapter) +- You can also enable taosAdapter to receive tcollector data by using the taosAdapter command line parameters or setting environment variables. -### 配置 TCollector +### Configuring TCollector -使用 TCollector 需下载其[源代码](https://github.com/OpenTSDB/tcollector)。其配置项在其源代码中。注意：TCollector 各个版本区别较大，这里仅以当前 master 分支最新代码 (git commit: 37ae920) 为例。 +To use TCollector, you need to download its [source code](https://github.com/OpenTSDB/tcollector). Its configuration items are in its source code. Note: TCollector differs significantly from version to version, so here is an example of the latest code for the current master branch (git commit: 37ae920). -修改 `collectors/etc/config.py` 和 `tcollector.py` 两个文件中相应内容。将原指向 OpenTSDB 宿主机的地址修改为 taosAdapter 被部署的服务器域名或 IP 地址，修改端口为 taosAdapter 支持 TCollector 使用的相应端口（默认为 6049）。 +Modify the contents of the `collectors/etc/config.py` and `tcollector.py` files. Change the address of the OpenTSDB host to the domain name or IP address of the server where taosAdapter is deployed, and change the port to the port that taosAdapter supports TCollector on (default is 6049). -示例为源代码修改内容的 git diff 输出： +Example of git diff output of source code changes. ``` index e7e7a1c..ec3e23c 100644 diff --git a/docs-en/14-reference/_telegraf.mdx b/docs-en/14-reference/_telegraf.mdx index bae46d6606..423e9c6b83 100644 --- a/docs-en/14-reference/_telegraf.mdx +++ b/docs-en/14-reference/_telegraf.mdx @@ -1,5 +1,5 @@ -在 Telegraf 配置文件（默认位置 /etc/telegraf/telegraf.conf） 增加 outputs.http 输出模块配置： +In the Telegraf configuration file (default location /etc/telegraf/telegraf.conf) add the outputs.http output module configuration. ``` [[outputs.http]] @@ -10,9 +10,9 @@ ... ``` -其中 请填写运行 taosAdapter 服务的服务器域名或 IP 地址， 请填写 REST 服务的端口（默认为 6041）， 和 请填写当前运行的 TDengine 实际配置， 请填写希望在 TDengine 保存 Telegraf 数据的数据库名。 +Where please fill in the server's domain name or IP address running the taosAdapter service. please fill in the port of the REST service (default is 6041). and please fill in the actual configuration of the currently running TDengine. And please fill in the database name where you want to store Telegraf data in TDengine. -示例如下： +An example is as follows. ``` [[outputs.http]] -- GitLab