Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add relevant documents for SMTP and NTP #1437

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Add relevant documents for SMTP and NTP #1437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions home/docs/help/ntp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
id: ntp
title: Monitoring NTP
sidebar_label: NTP Monitor
keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ]
---

> Collect and monitor the general performance Metrics of NTP.

**Protocol Use：NTP**

### Configuration parameter

| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |

### Collection Metrics

#### Metrics Set：summary

| Metric name | Metric unit | Metric help description |
|--------------|-------------|------------------------------------------------------------------------------------------|
| responseTime | ms | The time it takes for the NTP server to respond to a request). |
| time | ms | The current time reported by the NTP server). |
| date | | The date corresponding to the current time reported by the NTP server). |
| offset | ms | The time difference between the NTP server's clock and the client's clock). |
| delay | ms | The time it takes for a request to reach the NTP server and for the response to return). |
| version | | The version number of the NTP protocol used by the server). |
| mode | | The operating mode of the NTP server, such as client, server, or broadcast). |
| stratum | | The stratumevel of the NTP server, indicating its distance from a reference clock). |
| referenceId | | An identifier that indicates the reference clock or time source used by the NTP server). |
| precision | | The precision of the NTP server's clock, indicating its accuracy). |

36 changes: 36 additions & 0 deletions home/docs/help/smtp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# SMTP 监控

> 收集和监控 SMTP 的常规性能指标。

```text
通过 SMTP 的 hello 命令确定服务器是否可用
```

> 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13


**协议使用：SMTP**

### 配置参数

| 参数名称 | 参数帮助描述 |
|---------|---------------------------------------------------|
| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头（例如：https://、http://） |
| 监控名称 | 标识此监控的名称。名称需要保持唯一 |
| 端口 | SMTP 提供的端口号 |
| 电子邮件 | 您的电子邮件名称，用于 hello 命令的参数 |
| 超时时间 | 允许的收集响应时间 |
| 收集间隔 | 监视定期数据收集的间隔时间，单位：秒，最小可设置的间隔为 30 秒 |
| 是否检测可用性 | 是否在添加监控之前检测和验证监控的可用性。只有在检测成功后，才会继续进行添加和修改操作 |
| 描述备注 | 用于标识和描述此监控的更多信息，用户可以在此处添加备注信息 |

### 收集的指标

#### 指标集：概要

| 指标名称 | 指标单位 | 指标帮助描述 |
|-------------|------|-------------------|
| 响应时间 | 毫秒 | SMTP 服务器响应请求所需的时间 |
| 响应状态 | | 响应状态 |
| SMTP 服务器标语 | | SMTP 服务器的标语 |
| helo 命令返回信息 | | helo 命令返回的响应信息 |
34 changes: 34 additions & 0 deletions home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
NTP监控的中文文档如下：

# NTP监控

> 收集和监控NTP的常规性能指标。

**协议使用：NTP**

### 配置参数

| 参数名称 | 参数帮助描述 |
|------|--------------------------------------------------|
| 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头（例如：https://，http://） |
| 监控名称 | 标识此监控的名称。名称需要是唯一的 |
| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒 |
| 是否检测 | 是否在添加监控之前检测和检查监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 |
| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息 |

### 采集指标

#### 指标集：概要

| 指标名称 | 指标单位 | 指标帮助描述 |
|------|------|--------------------------|
| 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 |
| 时间 | 毫秒 | NTP服务器报告的当前时间。 |
| 日期 | | 与NTP服务器报告的当前时间对应的日期。 |
| 偏移量 | 毫秒 | NTP服务器的时钟与客户端时钟之间的时间差。 |
| 延迟 | 毫秒 | 请求到达NTP服务器并返回响应所需的时间。 |
| 版本号 | | 服务器使用的NTP协议的版本号。 |
| 模式 | | NTP服务器的操作模式，如客户端、服务器或广播。 |
| 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 |
| 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 |
| 精度 | | NTP服务器时钟的精度，表示其准确性。 |
42 changes: 42 additions & 0 deletions home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
id: smtp
title: Monitoring SMTP
sidebar_label: SMTP Monitor
keywords: [ open source monitoring tool, open source SMTP monitoring tool, monitoring SMTP metrics ]
---

> Collect and monitor the general performance Metrics of SMTP.

```text
Determine whether the server is available through the hello command in SMTP
```

> see https://datatracker.ietf.org/doc/html/rfc821#page-13


**Protocol Use：SMTP**

### Configuration parameter

| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by SMTP |
| Email | Your email name, parameters for the hello command |
| Timeout | Allow collection response time |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |

### Collection Metrics

#### Metrics Set：summary

| Metric name | Metric unit | Metric help description |
|--------------|-------------|----------------------------------------------------------------|
| responseTime | ms | The time it takes for the SMTP server to respond to a request. |
| response | | Response Status. |
| smtpBanner | | Banner of SMTP server. |
| heloInfo | | Response information returned by helo. |

Loading