This is an automated email from the ASF dual-hosted git repository.
gongchao 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 42fff48e2 [doc] add help document for dns monitoring (#1804)
42fff48e2 is described below
commit 42fff48e2aadea732de7dbd323d8117179f918c9
Author: LiuTianyou <[email protected]>
AuthorDate: Sun Apr 21 21:51:47 2024 +0800
[doc] add help document for dns monitoring (#1804)
Co-authored-by: LiuTianyou <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/dns.md | 69 ++++++++++++++++++++++
home/docs/help/guide.md | 1 +
.../current/help/dns.md | 68 +++++++++++++++++++++
.../current/help/guide.md | 1 +
home/sidebars.json | 3 +-
5 files changed, 141 insertions(+), 1 deletion(-)
diff --git a/home/docs/help/dns.md b/home/docs/help/dns.md
new file mode 100644
index 000000000..0dfa1a076
--- /dev/null
+++ b/home/docs/help/dns.md
@@ -0,0 +1,69 @@
+---
+id: dns
+title: Monitoring DNS
+sidebar_label: DNS Monitor
+keywords: [ open source monitoring tool, open source DNS monitoring tool,
monitoring DNS metrics ]
+---
+
+> Collect and monitor the general performance Metrics of DNS.
+
+**Protocol Use：DNS**
+
+### 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 port for DNS service provided to the
outside,default is 53.
|
+| Address For DNS | The address for domain name resolution.
|
+| Connect Timeout | Set the timeout for connecting to the DNS server,
default is 6000 milliseconds. |
+| Use TCP Protocol | DNS queries use the TCP protocol.
|
+| 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：Header
+
+| Metric name | Metric unit | Metric help description
|
+|-------------------------|-------------|---------------------------------------------------|
+| Response Time | ms | Time taken for DNS server to respond
to requests. |
+| Opcode | none | Type of the current message.
|
+| Response Status | none | Status code of the response.
|
+| Response Flags | none | Response flags.
|
+| Question Record Count | none | Number of question records.
|
+| Answer Record Count | none | Number of answer records.
|
+| Authority Record Count | none | Number of authoritative resource
records. |
+| Additional Record Count | none | Number of additional resource
records. |
+
+### Metrics Set: Question
+
+| Metric name | Metric unit | Metric help description
|
+|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| Section | none | Question record information, including the
queried domain name, resource type, resource record class, and additional
information. |
+
+### Metrics Set: Answer
+
+| Metric name | Metric unit | Metric help description
|
+|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------|
+| Section0 | none | Answer record information, including the queried
domain name, TTL, resource record class, resource type, and query result. |
+
+> The metric set collects up to 10 records, with metric names from Section0 to
Section9.
+
+### Metrics Set: Authority
+
+| Metric name | Metric unit | Metric help description
|
+|-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Section0 | none | SOA (Start of Authority) record for the domain
name, including queried domain name, TTL, resource type, resource record class,
and other information. |
+
+> The metric set collects up to 10 records, with metric names from Section0 to
Section9.
+
+### Metrics Set: Additional
+
+| Metric name | Metric unit | Metric help description |
+|-------------|-------------|-----------------------------------------|
+| Section0 | none | Additional information for DNS queries. |
+
+> The metric set collects up to 10 records, with metric names from Section0 to
Section9.
diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md
index 796909e79..c1649182c 100644
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -22,6 +22,7 @@ sidebar_label: Help Center
 👉 [SSL Cert monitoring](ssl_cert) <br />
 👉 [JVM monitoring](jvm) <br />
 👉 [SpringBoot2.0](springboot2) <br />
+ 👉 [DNS monitoring](dns) <br />
### Database monitoring
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md
new file mode 100644
index 000000000..775ca76c9
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md
@@ -0,0 +1,68 @@
+---
+id: dns
+title: 监控 DNS 服务器
+sidebar_label: DNS服务器
+keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ]
+---
+
+# 监控：DNS服务器
+
+> 收集和监控DNS的常规性能指标。
+
+**协议使用：DNS**
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|-----------|------------------------------------------------|
+| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：https://，http://）。 |
+| 监控名称 | 标识此监控的名称，名称需要是唯一的。 |
+| 端口 | DNS服务对外提供的端口，默认为53。 |
+| 域名解析的地址 | 域名解析的地址。 |
+| 连接超时时间 | 设置连接DNS服务器的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 |
+| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒。 |
+| 绑定标签 | 用于对监控资源进行分类管理。 |
+| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息。 |
+
+### 采集指标
+
+#### 指标集：Header
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-------|------|-----------------|
+| 响应时间 | 毫秒 | DNS服务器响应请求所需的时间 |
+| 操作码 | 无 | 当前消息的类型 |
+| 响应状态 | 无 | 响应的状态码 |
+| 响应标志 | 无 | 响应标志 |
+| 请求记录数 | 无 | 请求记录的数量 |
+| 响应记录数 | 无 | 响应记录的数量 |
+| 授权记录数 | 无 | 表示权威资源记录的数量 |
+| 附加记录数 | 无 | 表示附加资源记录的数量 |
+
+### 指标集: Question
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------|------|-----------------------------------|
+| Section | 无 | 请求记录信息，其中包含查询的域名，资源类型，资源记录类，附加信息。 |
+
+### 指标集: Answer
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|------|----------------------------------------|
+| Section0 | 无 | 请求响应信息，其中包含查询的域名，TTL，资源记录类，资源类型，查询的结果。 |
+> Answer 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。
+
+### 指标集: Authority
+
+| 指标名称 | 指标单位 | 指标帮助描述
|
+|----------|------|------------------------------------------------------------------|
+| Section0 | 无 | 域名的SOA（Start of
Authority，权威区域起始）记录，其中包含查询的域名，TTL，资源类型，资源记录类等信息。 |
+> Authority 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。
+
+### 指标集: Additional
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------|------|-------------|
+| Section0 | 无 | DNS查询的附加信息。 |
+> Additional 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。
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 d0298ee93..79ad40fd6 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
@@ -22,6 +22,7 @@ sidebar_label: 帮助入门
 👉 [SSL证书有效期](ssl_cert) <br />
 👉 [JVM虚拟机](jvm) <br />
 👉 [SpringBoot2.0](springboot2) <br />
+  👉 [DNS服务器](dns) <br />
### 数据库监控
diff --git a/home/sidebars.json b/home/sidebars.json
index 5f6fda95c..78bf5cba5 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -138,7 +138,8 @@
"help/nginx",
"help/pop3",
"help/smtp",
- "help/ntp"
+ "help/ntp",
+ "help/dns"
]
},
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
