This is an automated email from the ASF dual-hosted git repository.
zhaoqingran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 8755c11d9 [doc] Add help document for elasticsearch monitoring and ftp
monitoring (#1815)
8755c11d9 is described below
commit 8755c11d98c6100abda8e185ec381b423ed28a46
Author: LiuTianyou <[email protected]>
AuthorDate: Mon Apr 22 23:49:06 2024 +0800
[doc] Add help document for elasticsearch monitoring and ftp monitoring
(#1815)
Co-authored-by: Logic <[email protected]>
---
home/docs/help/elasticsearch.md | 63 ++++++++++++++++++++++
home/docs/help/ftp.md | 34 ++++++++++++
home/docs/help/guide.md | 2 +
.../current/help/elasticsearch.md | 63 ++++++++++++++++++++++
.../current/help/ftp.md | 34 ++++++++++++
.../current/help/guide.md | 2 +
home/sidebars.json | 6 ++-
7 files changed, 202 insertions(+), 2 deletions(-)
diff --git a/home/docs/help/elasticsearch.md b/home/docs/help/elasticsearch.md
new file mode 100644
index 000000000..250788508
--- /dev/null
+++ b/home/docs/help/elasticsearch.md
@@ -0,0 +1,63 @@
+---
+id: elasticsearch
+title: Monitoring：ElasticSearch
+sidebar_label: ElasticSearch
+keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ]
+---
+
+> Collect and monitor the general performance Metrics of ElasticSearch
+
+### Configuration parameter
+
+| Parameter name | Parameter help description
|
+|---------------------|--------------------------------------------------------------------------------------------------------------------------|
+| Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header
(eg: https://, http://). |
+| Monitoring name | Identify the name of this monitoring. The name needs
to be unique. |
+| Monitoring port | The HTTP API port opened by Elasticsearch,default is
9200. |
+| SSL | Whether SSL is enabled for connecting to
Elasticsearch.
|
+| Auth Type | Authentication type,Optional.
|
+| Username | Username,Optional.
|
+| Password | Password,Optional.
|
+| Connect Timeout | Set the timeout for elasticsearch query, default is
6000 milliseconds. |
+| Collection interval | Interval time of monitor periodic data collection,
unit: second, and the minimum interval that can be set is 30 seconds. |
+| Bind Tags | Used to classify and manage monitoring resources.
|
+| Description remarks | For more information about identifying and describing
this monitoring, users can note information here. |
+
+### Collection Metrics
+
+#### Metrics Set：health
+
+| Metric name | Metric unit | Metric help description
|
+|-----------------------|-------------|-------------------------------------------|
+| cluster_name | none | Cluster Name
|
+| status | none | status
|
+| nodes | none | Number of nodes in the cluster.
|
+| data_nodes | none | Number of data nodes in the cluster.
|
+| active_primary_shards | none | Number of active shards on primary
nodes. |
+| active_shards | none | Number of active shards.
|
+| active_percentage | % | Active Percentage
|
+| initializing_shards | none | Number of initialized shards.
|
+| unassigned_shards | none | Number of unassigned shards.
|
+
+#### Metrics Set：nodes
+
+| Metric name | Metric unit | Metric help description |
+|-------------|-------------|--------------------------|
+| total | none | Number of nodes. |
+| successful | none | Number of online nodes. |
+| failed | none | Number of offline nodes. |
+
+#### Metrics Set：nodes_detail
+
+| Metric name | Metric unit | Metric help description |
+|-------------------|-------------|-------------------------|
+| node_name | none | Node Name |
+| ip | none | IP Address |
+| cpu_load_average | none | Cpu Load Average |
+| cpu_percent | % | Cpu Percent |
+| heap_used | MB | Heap Used |
+| heap_used_percent | % | Heap Used Percent |
+| heap_total | MB | Heap Total |
+| disk_free | GB | Disk Free |
+| disk_total | GB | Disk Total |
+| disk_used_percent | % | Disk Used Percent |
diff --git a/home/docs/help/ftp.md b/home/docs/help/ftp.md
new file mode 100644
index 000000000..8802d3ab4
--- /dev/null
+++ b/home/docs/help/ftp.md
@@ -0,0 +1,34 @@
+---
+id: ftp
+title: Monitoring FTP
+sidebar_label: FTP Monitor
+keywords: [ open source monitoring tool, open source ftp server monitoring
tool, monitoring ftp metrics ]
+---
+
+> Collect and monitor the general performance Metrics of FTP server.
+
+**Protocol Use：FTP**
+
+### Configuration parameter
+
+| Parameter name | Parameter help description
|
+|---------------------|--------------------------------------------------------------------------------------------------------------------------|
+| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without
protocol header (eg: ftp://). |
+| Monitoring name | Identify the name of this monitoring, The name needs
to be unique. |
+| Port | Port provided by FTP server ,default is 21.
|
+| Direction | Directory on the FTP server.
|
+| Timeout | Timeout for connecting to FTP server.
|
+| Username | Username for connecting to the FTP server, optional.
|
+| Password | Password for connecting to the FTP server, optional.
|
+| Collection interval | Interval time of monitor periodic data collection,
unit: second, and the minimum interval that can be set is 30 seconds. |
+| Bind Tags | Used to classify and manage monitoring resources.
|
+| Description remarks | For more information about identifying and describing
this monitoring, users can note information here. |
+
+### Collection Metrics
+
+#### Metrics Set：Basic
+
+| Metric name | Metric unit | Metric help description
|
+|---------------|-------------|----------------------------------------------------------|
+| Is Active | none | Check if the directory exists and has access
permission. |
+| Response Time | ms | Response Time
|
diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md
index c1649182c..ada364e20 100644
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -23,6 +23,7 @@ sidebar_label: Help Center
 👉 [JVM monitoring](jvm) <br />
 👉 [SpringBoot2.0](springboot2) <br />
 👉 [DNS monitoring](dns) <br />
+ 👉 [FTP monitoring](ftp) <br />
### Database monitoring
@@ -61,6 +62,7 @@ sidebar_label: Help Center
### Bigdata monitoring
 👉 [Clickhouse](clickhouse) <br />
+ 👉 [ElasticSearch](elasticsearch) <br />
***
## 💡 Alarm service
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md
new file mode 100644
index 000000000..e64d956bc
--- /dev/null
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md
@@ -0,0 +1,63 @@
+---
+id: elasticsearch
+title: 监控：ElasticSearch
+sidebar_label: ElasticSearch
+keywords: [ 开源监控系统, 监控ElasticSearch ]
+---
+
+> 对ElasticSearch的通用性能指标进行采集监控。
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|---------|------------------------------------------------------|
+| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | ElasticSearch开放的HTTP API端口，默认值：9200。 |
+| 启用HTTPS | 是否启用HTTPS。 |
+| 认证方式 | 连接ElasticSearch使用的认证方式，可选。 |
+| 用户名 | 连接ElasticSearch的用户名，可选。 |
+| 密码 | 连接ElasticSearch的密码，可选 |
+| 查询超时时间 | 设置查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
+| 绑定标签 | 用于对监控资源进行分类管理。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+
+### 采集指标
+
+#### 指标集合：health
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------------------|------|----------|
+| cluster_name | 无 | 集群名称 |
+| status | 无 | 集群状态 |
+| nodes | 无 | 集群节点数 |
+| data_nodes | 无 | 数据节点数 |
+| active_primary_shards | 无 | 主节点活跃分片数 |
+| active_shards | 无 | 活跃分片数 |
+| active_percentage | % | 分片健康度 |
+| initializing_shards | 无 | 初始化分片数 |
+| unassigned_shards | 无 | 未分配分片数 |
+
+#### 指标集合：nodes
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------|------|--------|
+| total | 无 | 节点数 |
+| successful | 无 | 在线节点数 |
+| failed | 无 | 离线节点数 |
+
+#### 指标集合：nodes_detail
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-------------------|------|---------|
+| node_name | 无 | 节点名称 |
+| ip | 无 | IP地址 |
+| cpu_load_average | 无 | CPU平均负载 |
+| cpu_percent | % | CPU占用率 |
+| heap_used | MB | 内存使用量 |
+| heap_used_percent | % | 内存使用率 |
+| heap_total | MB | 总内存 |
+| disk_free | GB | 磁盘剩余容量 |
+| disk_total | GB | 磁盘总容量 |
+| disk_used_percent | % | 磁盘使用率 |
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md
new file mode 100644
index 000000000..c86dfb14a
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md
@@ -0,0 +1,34 @@
+---
+id: ftp
+title: 监控：FTP服务器
+sidebar_label: FTP服务器
+keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 ]
+---
+
+> 采集和监控FTP服务的通用指标
+
+**协议使用：FTP**
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|--------|--------------------------------------|
+| 目标Host | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：ftp://）。 |
+| 监控名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | FTP服务端口，默认值：21。 |
+| 目录 | FTP服务托管的目录。 |
+| 超时时间 | 连接FTP服务器超时时间，默认值：1000毫秒。 |
+| 用户名 | 连接FTP服务的用户名， 可选。 |
+| 密码 | 连接FTP服务的密码，可选。 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 |
+| 绑定标签 | 用于对监控资源进行分类管理。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+
+### 采集指标
+
+#### 指标集合：概要
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------|------|------------------|
+| 活动状态 | 无 | 检查目录是否存在，且具有访问权限 |
+| 响应时间 | ms | 连接FTP响应时间 |
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
index 79ad40fd6..c810ea25f 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md
@@ -23,6 +23,7 @@ sidebar_label: 帮助入门
 👉 [JVM虚拟机](jvm) <br />
 👉 [SpringBoot2.0](springboot2) <br />
 👉 [DNS服务器](dns) <br />
+  👉 [FTP服务器](ftp) <br />
### 数据库监控
@@ -61,6 +62,7 @@ sidebar_label: 帮助入门
### 大数据监控
 👉 [Clickhouse](clickhouse) <br />
+  👉 [ElasticSearch](elasticsearch) <br />
## 💡 告警服务
diff --git a/home/sidebars.json b/home/sidebars.json
index fa730b00a..86f4f0fbf 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -139,7 +139,8 @@
"help/pop3",
"help/smtp",
"help/ntp",
- "help/dns"
+ "help/dns",
+ "help/ftp"
]
},
{
@@ -205,7 +206,8 @@
"help/iotdb",
"help/hive",
"help/airflow",
- "help/clickhouse"
+ "help/clickhouse",
+ "help/elasticsearch"
]
},
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
