This is an automated email from the ASF dual-hosted git repository.
gaoxingcun 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 2fa3b5aed [doc]Doc add debian system (#1842)
2fa3b5aed is described below
commit 2fa3b5aed05ab5591faaea616c2236d37f4e86ce
Author: Jast <[email protected]>
AuthorDate: Thu Apr 25 14:10:21 2024 +0800
[doc]Doc add debian system (#1842)
Co-authored-by: zhangshenghang <[email protected]>
---
home/docs/help/debian.md | 101 ++++++++++++++++++++
.../current/help/debian.md | 105 +++++++++++++++++++++
home/sidebars.json | 1 +
3 files changed, 207 insertions(+)
diff --git a/home/docs/help/debian.md b/home/docs/help/debian.md
new file mode 100644
index 000000000..65940c34a
--- /dev/null
+++ b/home/docs/help/debian.md
@@ -0,0 +1,101 @@
+---
+id: debian
+title: Monitoring Debian System Monitoring
+sidebar_label: Debian
+keywords: [Open Source Monitoring System, Operating System Monitoring, Debian
Monitoring]
+---
+> Collect and monitor general performance metrics of the Debian system.
+
+## Configuration Parameters
+
+
+| Parameter Name | Metric help description
|
+| ----------------------- |
-----------------------------------------------------------------------------------------------------------------
|
+| Target Host | The monitored destination IPV4, IPV6, or domain
name. Note: no protocol header (e.g., https://, http://). |
+| Task Name | A unique name to identify this monitoring task.
|
+| Port | SSH port of the Debian system, default: 22
|
+| Timeout | Timeout for the connection, in milliseconds,
default: 6000 milliseconds. |
+| Connection Reuse | Whether to reuse the SSH connection, default:
false. False means a new connection will be created for each query. |
+| Username | Server username
|
+| Password | Server password
|
+| Collector | Configure which collector to use for scheduling
this monitoring. |
+| Monitoring Period | The interval for periodically collecting data, in
seconds, with a minimum interval of 30 seconds. |
+| Binding Tags | Used for categorizing and managing monitoring
resources. |
+| Metric help description | Additional notes and Metric help descriptions for
this monitoring, users can add notes here. |
+| Key | Key required to connect to the server.
|
+
+### Monitoring Metrics
+
+#### Metric Set: Basic System Information
+
+
+| Metric Name | Metric Unit | Metric help description |
+| -------------- | ----------- | ------------------------ |
+| Host Name | N/A | Host name |
+| System Version | N/A | Operating system version |
+| Uptime | N/A | Boot time |
+
+#### Metric Set: CPU Information
+
+
+| Metric Name | Metric Unit | Metric help description |
+| -------------- | ----------- | ----------------------- |
+| Info | N/A | Model |
+| Cores | N/A | Number of cores |
+| Interrupt | N/A | Number of interrupts |
+| Load | N/A | Load |
+| Context Switch | N/A | Context switches |
+| Usage | % | Usage rate |
+
+#### Metric Set: Memory Information
+
+
+| Metric Name | Metric Unit | Metric help description |
+| ------------------- | ----------- | ---------------------------- |
+| Total Memory | Mb | Total memory capacity |
+| User Program Memory | Mb | Memory used by user programs |
+| Free Memory | Mb | Free memory capacity |
+| Buff Cache Memory | Mb | Memory used by cache |
+| Available Memory | Mb | Available memory |
+| Memory Usage | % | Memory usage rate |
+
+#### Metric Set: Disk Information
+
+
+| Metric Name | Metric Unit | Metric help description |
+| ------------- | ----------- | ----------------------------- |
+| Disk Num | N/A | Total number of disks |
+| Partition Num | N/A | Total number of partitions |
+| Block Write | N/A | Number of disk blocks written |
+| Block Read | N/A | Number of disk blocks read |
+| Write Rate | iops | Disk write rate |
+
+#### Metric Set: Network Interface Information
+
+Statistics for all network interface cards, including interface name, incoming
data traffic, and outgoing data traffic.
+Metric Unit: Mb
+
+#### Metric Set: File System
+
+Statistics for all mounted file systems. Statistics include: file system,
usage, available space, usage rate, mount point.
+Metric Unit:
+
+- Usage: Mb
+- Available Space: Mb
+- Usage Rate: %
+
+#### Metric Set: Top 10 CPU Processes
+
+Statistics for the top 10 processes by CPU usage. Statistics include: process
ID, CPU usage rate, memory usage rate, command being executed.
+Metric Unit:
+
+- CPU Usage Rate: %
+- Memory Usage Rate: %
+
+#### Metric Set: Top 10 Memory Processes
+
+Statistics for the top 10 processes by memory usage. Statistics include:
process ID, memory usage rate, CPU usage rate, command being executed.
+Metric Unit:
+
+- Memory Usage Rate: %
+- CPU Usage Rate: %
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md
new file mode 100644
index 000000000..dcda89ee2
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md
@@ -0,0 +1,105 @@
+---
+id: debian
+title: 监控：debian 系统监控
+sidebar_label: Debian
+keywords: [开源监控系统, 操作系统监控, Debian监控]
+---
+> 对Debian系统的通用性能指标进行采集监控
+
+## 配置参数
+
+
+| 参数名称 | 参数帮助描述 |
+| -------- |
------------------------------------------------------------------------- |
+| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | Debian系统的ssh端口，默认: 22 |
+| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 |
+| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 |
+| 用户名 | 服务器用户名 |
+| 密码 | 服务器密码
|
+| 采集器 | 配置此监控使用哪台采集器调度采集 |
+| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
+| 绑定标签 | 用于对监控资源进行分类管理 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
+| 密钥 | 连接服务器所需密钥 |
+
+### 采集指标
+
+#### 指标集合：系统基本信息
+
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| -------------- | -------- | ------------ |
+| Host Name | 无 | 主机名称 |
+| System Version | 无 | 操作系统版本 |
+| Uptime | 无 | 启动时间 |
+
+#### 指标集合：CPU 信息
+
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| -------------- | -------- | ------------ |
+| Info | 无 | 型号 |
+| Cores | 无 | 核数 |
+| Interrupt | 无 | 中断数 |
+| Load | 无 | 负载 |
+| Context Switch | 无 | 上下文切换 |
+| Usage | % | 使用率 |
+
+#### 指标集合：内存信息
+
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ------------------- | -------- | -------------- |
+| Total Memory | Mb | 总内存容量 |
+| User Program Memory | Mb | 用户程序内存量 |
+| Free Memory | Mb | 空闲内存容量 |
+| Buff Cache Memory | Mb | 缓存占用内存 |
+| Available Memory | Mb | 剩余可用内存 |
+| Memory Usage | % | 内存使用率 |
+
+#### 指标集合：磁盘信息
+
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ------------- | -------- | ------------ |
+| Disk Num | 无 | 磁盘总数 |
+| Partition Num | 无 | 分区总数 |
+| Block Write | 无 | 写磁盘块数 |
+| Block Read | 无 | 读磁盘块数 |
+| Write Rate | iops | 磁盘写速率 |
+
+#### 指标集合：网卡信息
+
+统计所有网卡的网卡名称、入站数据流量、出站数据流量。
+
+单位：Mb
+
+#### 指标集合：文件系统
+
+统计所有挂载的文件系统的使用情况。统计信息包括：文件系统、已使用量、可用量、使用率、挂载点。
+
+单位：
+
+- 已使用量：Mb
+- 可用量：Mb
+- 使用率：%
+
+#### 指标集合：Top10 CPU进程
+
+统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。
+
+单位：
+
+- CPU占用率：%
+- 内存占用率：%
+
+#### 指标集合：Top10 内存进程
+
+统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。
+
+单位：
+
+- 内存占用率：%
+- CPU占用率：%
diff --git a/home/sidebars.json b/home/sidebars.json
index a5e5cd131..ee96933da 100644
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -186,6 +186,7 @@
"help/linux",
"help/windows",
"help/ubuntu",
+ "help/debian",
"help/centos"
]
},
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
