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 c79ada54e [doc] add help document for eulerOS monitoring (#1960)
c79ada54e is described below
commit c79ada54e5abc71ae43b57e662a8a383cd24eaee
Author: liutianyou <[email protected]>
AuthorDate: Sat May 11 10:50:56 2024 +0800
[doc] add help document for eulerOS monitoring (#1960)
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/euleros.md | 107 +++++++++++++++++++++
home/docs/help/guide.md | 1 +
.../current/help/euleros.md | 107 +++++++++++++++++++++
.../current/help/guide.md | 1 +
home/sidebars.json | 3 +-
5 files changed, 218 insertions(+), 1 deletion(-)
diff --git a/home/docs/help/euleros.md b/home/docs/help/euleros.md
new file mode 100644
index 000000000..c63c6c266
--- /dev/null
+++ b/home/docs/help/euleros.md
@@ -0,0 +1,107 @@
+---
+id: euleros
+title: Monitoring EulerOS
+sidebar_label: EulerOS
+keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS
Monitoring ]
+---
+
+> Collect and monitor general performance metrics for EulerOS (system
information, CPU, memory, disk, network interface, file system, top resource
processes, etc.).
+
+### Configuration Parameters
+
+| Parameter Name | Parameter help description
|
+|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| Monitoring Host | The IP, IPV6, or domain name of the monitored
endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://).
|
+| Task Name | Identifies the name of this monitoring, ensuring
uniqueness.
|
+| Port | Port provided by Linux SSH externally, defaults to 22.
|
+| Timeout | Sets the timeout for connection in milliseconds (ms),
defaults to 6000 ms. |
+| Connection Reuse | Sets whether the SSH connection is reused, defaults
to: false. Creates a new connection for each information retrieval if false. |
+| Username | SSH connection username, optional.
|
+| Password | SSH connection password, optional.
|
+| Collector | Specifies which collector schedules the collection for
this monitoring. |
+| Monitoring Interval | Interval for periodically collecting data, in seconds.
Minimum interval is 30 seconds. |
+| Binding Tags | Used for categorizing and managing monitored
resources.
|
+| Description | Additional remarks and descriptions for this
monitoring, for users' reference.
|
+| PrivateKey | Key required for connecting to the server.
|
+
+### Collected Metrics
+
+#### Metric Set: Basic Info
+
+| Metric Name | Metric Unit | Metric help description |
+|----------------|-------------|---------------------------|
+| Host Name | None | Host name. |
+| System Version | None | Operating system version. |
+| Uptime | None | System uptime. |
+
+#### Metric Set: CPU Info
+
+| Metric Name | Metric Unit | Metric help description |
+|----------------|-------------|-------------------------------------------|
+| info | None | CPU model. |
+| cores | None | Number of CPU cores. |
+| interrupt | None | Number of CPU interrupts. |
+| load | None | Average load for the last 1/5/15 minutes. |
+| context_switch | None | Current context switches. |
+| usage | % | CPU usage percentage. |
+
+#### Metric Set: Memory Info
+
+| Metric Name | Metric Unit | Metric help description |
+|-------------|-------------|------------------------------------|
+| total | Mb | Total memory capacity. |
+| used | Mb | Used memory by user programs. |
+| free | Mb | Free memory capacity. |
+| buff_cache | Mb | Memory used for buffers and cache. |
+| available | Mb | Available memory capacity. |
+| usage | % | Memory usage percentage. |
+
+#### Metric Set: Disk Info
+
+| Metric Name | Metric Unit | Metric help description |
+|---------------|-------------|------------------------------------|
+| disk_num | None | Total number of disks. |
+| partition_num | None | Total number of partitions. |
+| block_write | None | Total blocks written to disk. |
+| block_read | None | Total blocks read from disk. |
+| write_rate | iops | Rate of blocks written per second. |
+
+#### Metric Set: Interface Info
+
+| Metric Name | Metric Unit | Metric help description |
+|----------------|-------------|--------------------------------|
+| interface_name | None | Name of the network interface. |
+| receive_bytes | Mb | Inbound data traffic. |
+| transmit_bytes | Mb | Outbound data traffic. |
+
+#### Metric Set: Disk Free
+
+| Metric Name | Metric Unit | Metric help description |
+|-------------|-------------|--------------------------|
+| filesystem | None | Name of the file system. |
+| used | Mb | Used disk space. |
+| available | Mb | Available disk space. |
+| usage | % | Disk usage percentage. |
+| mounted | None | Mount point directory. |
+
+#### Metric Set: Top10 CPU Process
+
+Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory
usage, Command.
+
+| Metric Name | Metric Unit | Metric help description |
+|-------------|-------------|-------------------------|
+| pid | None | Process ID |
+| cpu_usage | % | CPU usage |
+| mem_usage | % | Memory usage |
+| command | None | Executed command |
+
+#### Metric Set: Top10 Memory Process
+
+Top 10 processes consuming memory. Metrics include: Process ID, Memory usage,
CPU usage, Command.
+
+| Metric Name | Metric Unit | Metric help description |
+|-------------|-------------|-------------------------|
+| pid | None | Process ID |
+| mem_usage | % | Memory usage |
+| cpu_usage | % | CPU usage |
+| command | None | Executed command |
diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md
index 4075da58c..e3df2b64a 100644
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -61,6 +61,7 @@ sidebar_label: Help Center
 👉 [FreeBSD operating system monitoring](freebsd) <br />
 👉 [RedHat operating system monitoring](redhat) <br />
 👉 [Rocky Linux operating system monitoring](rockylinux) <br
/>
+ 👉 [EulerOS monitoring](euleros) <br />
### Middleware monitoring
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md
new file mode 100644
index 000000000..258f7bb36
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md
@@ -0,0 +1,107 @@
+---
+id: euleros
+title: 监控：EulerOS操作系统监控
+sidebar_label: EulerOS操作系统
+keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监控 ]
+---
+
+> 对EulerOS操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+|--------|------------------------------------------------------|
+| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | Linux SSH对外提供的端口，默认为22。 |
+| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接。 |
+| 用户名 | SSH连接用户名，可选。 |
+| 密码 | SSH连接密码，可选。 |
+| 采集器 | 配置此监控使用哪台采集器调度采集。 |
+| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 |
+| 绑定标签 | 用于对监控资源进行分类管理。 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 |
+| 密钥 | 连接服务器所需密钥。 |
+
+### 采集指标
+
+#### 指标集合：系统基本信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------------|------|--------|
+| Host Name | 无 | 主机名称 |
+| System Version | 无 | 操作系统版本 |
+| Uptime | 无 | 启动时间 |
+
+#### 指标集合：CPU 信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------------|------|--------------------|
+| info | 无 | CPU型号 |
+| cores | 无 | CPU内核数量 |
+| interrupt | 无 | CPU中断数量 |
+| load | 无 | CPU最近1/5/15分钟的平均负载 |
+| context_switch | 无 | 当前上下文切换数量 |
+| usage | % | CPU使用率 |
+
+#### 指标集合：内存信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------|------|----------|
+| total | Mb | 总内存容量 |
+| used | Mb | 用户程序内存量 |
+| free | Mb | 空闲内存容量 |
+| buff_cache | Mb | 缓存占用内存 |
+| available | Mb | 剩余可用内存容量 |
+| usage | % | 内存使用率 |
+
+#### 指标集合：磁盘信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------------|------|-----------|
+| disk_num | 无 | 磁盘总数 |
+| partition_num | 无 | 分区总数 |
+| block_write | 无 | 写入磁盘的总块数 |
+| block_read | 无 | 从磁盘读出的块数 |
+| write_rate | iops | 每秒写磁盘块的速率 |
+
+#### 指标集合：网卡信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|----------------|------|--------|
+| interface_name | 无 | 网卡名称 |
+| receive_bytes | Mb | 入站数据流量 |
+| transmit_bytes | Mb | 出站数据流量 |
+
+#### 指标集合：文件系统
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------|------|---------|
+| filesystem | 无 | 文件系统的名称 |
+| used | Mb | 已使用磁盘大小 |
+| available | Mb | 可用磁盘大小 |
+| usage | % | 使用率 |
+| mounted | 无 | 挂载点目录 |
+
+#### 指标集合：Top10 CPU进程
+
+统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------|------|--------|
+| pid | 无 | 进程ID |
+| cpu_usage | % | CPU占用率 |
+| mem_usage | % | 内存占用率 |
+| command | 无 | 执行命令 |
+
+#### 指标集合：Top10 内存进程
+
+统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|-----------|------|--------|
+| pid | 无 | 进程ID |
+| mem_usage | % | 内存占用率 |
+| cpu_usage | % | CPU占用率 |
+| command | 无 | 执行命令 |
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 e220497ee..1ca5581e2 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
@@ -63,6 +63,7 @@ sidebar_label: 帮助入门
 👉 [FreeBSD操作系统监控](freebsd) <br />
 👉 [RedHat操作系统监控](redhat) <br />
 👉 [RockyLinux操作系统监控](rockylinux) <br />
+  👉 [EulerOS操作系统监控](euleros) <br />
### 中间件监控
diff --git a/home/sidebars.json b/home/sidebars.json
index cc816f2dd..6a6311f24 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -205,7 +205,8 @@
"help/opensuse",
"help/freebsd",
"help/redhat",
- "help/rockylinux"
+ "help/rockylinux",
+ "help/euleros"
]
},
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
