forked from apache/hertzbeat
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[doc] add help document for freebsd monitoring (apache#1928)
- Loading branch information
1 parent
7974d92
commit 26df2c4
Showing
5 changed files
with
180 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| id: freebsd | ||
| title: Monitoring FreeBSD Operating System | ||
| sidebar_label: FreeBSD Operating System | ||
| keywords: [ Open Source Monitoring System, Open Source Operating System Monitoring, FreeBSD Operating System Monitoring ] | ||
| --- | ||
|
|
||
| > Collect and monitor general performance metrics (system information, CPU, memory, disk, network cards, file systems, top resource processes, etc.) of the FreeBSD operating system. | ||
| ### Configuration Parameters | ||
|
|
||
| | Parameter Name | Parameter help description | | ||
| |---------------------|------------------------------------------------------------------------------------------------------------------------------| | ||
| | Monitoring Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | | ||
| | Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | | ||
| | Port | The port where SSH for Linux is exposed, default is 22. | | ||
| | Timeout | Set the connection timeout, in milliseconds, default is 6000 milliseconds. | | ||
| | Reuse Connection | Set whether SSH connections are reused, default is: false. If false, a connection is created for each information retrieval. | | ||
| | Username | SSH connection username, optional. | | ||
| | Password | SSH connection password, optional. | | ||
| | Collector | Configure which collector to use for scheduling collection for this monitor. | | ||
| | Monitoring Interval | Interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. | | ||
| | Bind Labels | Used to categorize and manage monitored resources. | | ||
| | Description | Additional information for identifying and describing this monitor. Users can add remarks here. | | ||
| | PrivateKey | Private key required to connect to the server. | | ||
|
|
||
| ### Collection 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 | Number | Number of CPU cores | | ||
| | interrupt | Number | Number of CPU interrupts | | ||
| | load | None | Average CPU load for the last 1/5/15 minutes | | ||
| | context_switch | Number | Current context switches | | ||
| | usage | % | CPU usage | | ||
|
|
||
| #### Metric Set: Memory Info | ||
|
|
||
| | Metric Name | Metric Unit | Metric help description | | ||
| |-------------|-------------|-------------------------| | ||
| | physmem | Mb | Physical memory | | ||
| | usermem | Mb | User program memory | | ||
| | realmem | Mb | Actual memory | | ||
| | availmem | Mb | Available memory | | ||
|
|
||
| #### Metric Set: Disk Free | ||
|
|
||
| | Metric Name | Metric Unit | Metric help description | | ||
| |-------------|-------------|-------------------------| | ||
| | filesystem | None | File system name | | ||
| | used | Mb | Used disk space | | ||
| | available | Mb | Available disk space | | ||
| | usage | % | Usage percentage | | ||
| | mounted | None | Mount point directory | | ||
|
|
||
| #### Metric Set: Top10 CPU Process | ||
|
|
||
| Statistics of the top 10 processes using CPU. Statistics include: Process ID, CPU usage, memory usage, executed 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 | ||
|
|
||
| Statistics of the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command. | ||
|
|
||
| | Metric Name | Metric Unit | Metric help description | | ||
| |-------------|-------------|-------------------------| | ||
| | pid | None | Process ID | | ||
| | mem_usage | % | Memory usage | | ||
| | cpu_usage | % | CPU usage | | ||
| | command | None | Executed command | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| id: freebsd | ||
| title: 监控：FreeBSD操作系统监控 | ||
| sidebar_label: FreeBSD操作系统 | ||
| keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监控 ] | ||
| --- | ||
|
|
||
| > 对FreeBSD操作系统的通用性能指标 (系统信息、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使用率 | | ||
|
|
||
| #### 指标集合：内存信息 | ||
|
|
||
| | 指标名称 | 指标单位 | 指标帮助描述 | | ||
| |----------|------|---------| | ||
| | physmem | Mb | 物理内存 | | ||
| | usermem | Mb | 用户程序内存量 | | ||
| | realmem | Mb | 实际内存 | | ||
| | availmem | 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 | 无 | 执行命令 | | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters