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.

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

[doc] add opensuse doc #1902

Merged
merged 9 commits into from
May 1, 2024
106 changes: 106 additions & 0 deletions home/docs/help/opensuse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
id: opensuse
title: Monitoring OpenSUSE Operating System Monitoring
sidebar_label: OpenSUSE OS
keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring]
---
> Collect and monitor general performance metrics of the OpenSUSE operating system.

### Configuration Parameters

| Parameter Name | Parameter Help Description |
| -------------- | ---------------------------------------------------------------------------- |
| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). |
| Task Name | The name that identifies this monitoring, which must be unique. |
| Port | The port provided by Linux SSH, default is 22. |
| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. |
| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Configures which collector is used to schedule data collection for this monitoring. |
| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. |
| Binding Tags | Used for categorized management of monitoring resources. |
| Description | Additional notes and descriptions for this monitoring, where users can make notes. |
| Key | The key required to connect to the server. |

### Collection Metrics

#### Metric Set: System Basic Information

| Metric Name | Unit | Metric Help Description |
| --------------- | ------- | ------------------------ |
| Host Name | None | Host name |
| System Version | None | Operating system version|
| Uptime | None | Uptime |

#### Metric Set: CPU Information

| Metric Name | Unit | Metric Help Description |
| --------------- | ----- | ---------------------------------- |
| info | None | CPU model |
| cores | Cores | Number of CPU cores |
| interrupt | Count | Number of CPU interrupts |
| load | None | Average CPU load over the last 1/5/15 minutes |
| context_switch | Count | Number of context switches |
| usage | % | CPU usage rate |

#### Metric Set: Memory Information

| Metric Name | Unit | Metric Help Description |
| ----------- | ---- | ------------------------ |
| total | Mb | Total memory capacity |
| used | Mb | Memory used by user programs |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory used for cache |
| available | Mb | Remaining available memory capacity |
| usage | % | Memory usage rate |

#### Metric Set: Disk Information

| Metric Name | Unit | Metric Help Description |
| --------------- | ----- | ----------------------------- |
| disk_num | Count | Total number of disks |
| partition_num | Count | Total number of partitions |
| block_write | Count | Total number of blocks written to disk |
| block_read | Count | Total number of blocks read from disk |
| write_rate | iops | Disk block write rate per second |

#### Metric Set: Network Card Information

| Metric Name | Unit | Metric Help Description |
| ------------------- | ---- | -------------------------- |
| interface_name | None | Network card name |
| receive_bytes | Mb | Inbound data traffic |
| transmit_bytes | Mb | Outbound data traffic |

#### Metric Set: File System

| Metric Name | Unit | Metric Help Description |
| ---------- | ---- | ------------------------ |
| filesystem | None | Name of the file system |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | Usage rate |
| mounted | None | Mount point directory |

#### Metric Set: Top 10 CPU Processes

Statistics for the top 10 processes using the CPU. Statistics include: Process ID, CPU usage, memory usage, executed command.

| Metric Name | Unit | Metric Help Description |
| ------------ | ---- | ------------------------ |
| pid | None | Process ID |
| cpu_usage | % | CPU usage rate |
| mem_usage | % | Memory usage rate |
| command | None | Executed command |

#### Metric Set: Top 10 Memory Processes

Statistics for the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command.

| Metric Name | Unit | Metric Help Description |
| ------------ | ---- | ------------------------ |
| pid | None | Process ID |
| mem_usage | % | Memory usage rate |
| cpu_usage | % | CPU usage rate |
| command | None | Executed command |
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
id: opensuse
title: 监控:OpenSUSE操作系统监控
sidebar_label: OpenSUSE操作系统
keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监控]
---
> 对OpenSUSE操作系统的通用性能指标进行采集监控。

### 配置参数


| 参数名称 | 参数帮助描述 |
| -------- | ------------------------------------------------------------------------- |
| 监控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 | 无 | 执行命令 |
3 changes: 2 additions & 1 deletion home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@
"help/ubuntu",
"help/debian",
"help/centos",
"help/almalinux"
"help/almalinux",
"help/opensuse"
]
},
{
Expand Down
Loading