Skip to content

Commit

Permalink
[doc] improve windows monitoring doc(apache#2869)
Browse files Browse the repository at this point in the history
  • Loading branch information
@starryCoder
starryCoder authored Dec 12, 2024
1 parent 86ad10a commit 1280c61
Show file tree
Hide file tree
Showing 2 changed files with 145 additions and 3 deletions.
73 changes: 72 additions & 1 deletion home/docs/help/windows.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ References:

#### Metric set：system

| Metric name | Metric unit | Metric help description |
| Metric name | Metric unit | Metric help description |
|--------------|-------------|------------------------------|
| name | none | Host name |
| descr | none | Operating system description |
Expand All @@ -41,3 +41,74 @@ References:
| services | number | Current number of services |
| processes | number | Current number of processes |
| responseTime | ms | Collection response time |
| location | none | Location |
| memory | GB | System memory |

#### Metric set: process

| Field name | Metric unit | Metric help description |
|-------------------|-------------|-------------------------|
| hrSWRunIndex | none | Index |
| hrSWRunName | none | Process name |
| hrSWRunID | none | Process ID |
| hrSWRunPath | none | Process path |
| hrSWRunParameters | none | Process parameters |
| hrSWRunType | none | Process type |
| hrSWRunStatus | none | Process status |
| hrSWRunPerfCPU | s | Process CPU usage |
| hrSWRunPerfMem | KB | Process memory usage |

#### Metric set: service

| Field name | Metric unit | Metric help description |
|-----------------------|-------------|-------------------------|
| svSvcName | none | Service name |
| svSvcInstalledState | none | Service installed state |
| svSvcOperatingState | none | Service operating state |
| svSvcCanBeUninstalled | none | Can be uninstalled |
| svSvcCanBePaused | none | Can be paused |

#### Metric set: installation

| Field name | Metric unit | Metric help description |
|--------------------|-------------|-------------------------|
| hrSWInstalledIndex | none | Index |
| hrSWInstalledName | none | Installed name |
| hrSWInstalledID | none | Installed ID |
| hrSWInstalledType | none | Installed type |

#### Metric set: storage

| Field name | Metric unit | Metric help description |
|------------|-------------|-------------------------|
| index | none | Index |
| descr | none | Storage description |
| size | Mb | Storage size |
| free | Mb | Free space |
| used | Mb | Used space |
| usage | % | Usage percentage |

#### Metric set: interface details

| Field name | Metric unit | Metric help description |
|--------------|-------------|----------------------------|
| index | none | Index |
| descr | none | Interface name |
| speed | Mbps | Interface speed |
| in_octets | Kbps | Inbound traffic |
| out_octets | Kbps | Outbound traffic |
| admin_status | none | Administrative status |
| oper_status | none | Operational status |
| mtu | B | MTU |
| in_discards | number | Inbound discarded packets |
| in_errors | number | Inbound error packets |
| out_discards | number | Outbound discarded packets |
| out_errors | number | Outbound error packets |

#### Metric set: device

| Field name | Metric unit | Metric help description |
|------------|-------------|-------------------------|
| index | none | Index |
| descr | none | Description |
| status | none | Status |
75 changes: 73 additions & 2 deletions home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监

### 采集指标

#### 指标集合：system
#### 指标集合：系统

| 指标名称 | 指标单位 | 指标帮助描述 |
| 指标名称 | 指标单位 | 指标帮助描述 |
|--------------|------|--------|
| name | 无 | 主机名称 |
| descr | 无 | 操作系统描述 |
Expand All @@ -41,3 +41,74 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监
| services | 个数 | 当前服务数量 |
| processes | 个数 | 当前进程数量 |
| responseTime | ms | 采集响应时间 |
| location | 无 | 位置 |
| memory | GB | 系统内存 |

#### 指标集合：进程

| 字段名称 | 指标单位 | 指标帮助描述 |
|-------------------|------|----------|
| hrSWRunIndex | 无 | 编号 |
| hrSWRunName | 无 | 进程名称 |
| hrSWRunID | 无 | 进程 ID |
| hrSWRunPath | 无 | 进程路径 |
| hrSWRunParameters | 无 | 进程参数 |
| hrSWRunType | 无 | 进程类型 |
| hrSWRunStatus | 无 | 进程状态 |
| hrSWRunPerfCPU | s | 进程占用 CPU |
| hrSWRunPerfMem | KB | 进程占用内存 |

#### 指标集合：服务

| 字段名称 | 指标单位 | 指标帮助描述 |
|-----------------------|------|-----------|
| svSvcName | 无 | 服务名称 |
| svSvcInstalledState | 无 | 服务安装状态 |
| svSvcOperatingState | 无 | 服务运行状态 |
| svSvcCanBeUninstalled | 无 | 服务是否可以被卸载 |
| svSvcCanBePaused | 无 | 服务是否可以被暂停 |

#### 指标集合：安装

| 字段名称 | 指标单位 | 指标帮助描述 |
|--------------------|------|--------|
| hrSWInstalledIndex | 无 | 编号 |
| hrSWInstalledName | 无 | 安装名称 |
| hrSWInstalledID | 无 | 安装 ID |
| hrSWInstalledType | 无 | 安装类型 |

#### 指标集合：存储

| 字段名称 | 指标单位 | 指标帮助描述 |
|-------|------|--------|
| index | 无 | 编号 |
| descr | 无 | 存储描述 |
| size | Mb | 存储大小 |
| free | Mb | 存储空闲 |
| used | Mb | 存储占用 |
| usage | % | 存储使用率 |

#### 指标集合：接口详情

| 字段名称 | 指标单位 | 指标帮助描述 |
|--------------|------|--------|
| index | 无 | 编号 |
| descr | 无 | 接口名称 |
| speed | Mbps | 接口速率 |
| in_octets | Kbps | 入流量 |
| out_octets | Kbps | 出流量 |
| admin_status | 无 | 配置状态 |
| oper_status | 无 | 当前状态 |
| mtu | B | MTU |
| in_discards | 个数 | 入丢包数 |
| in_errors | 个数 | 入错包数 |
| out_discards | 个数 | 出丢包数 |
| out_errors | 个数 | 出错包数 |

#### 指标集合：设备

| 字段名称 | 指标单位 | 指标帮助描述 |
|----------|------|--------|
| index | 无 | 编号 |
| descr | 无 | 描述 |
| status | 无 | 状态 |

0 comments on commit 1280c61

Please sign in to comment.