网络指标的语义约定
状态: 开发中
网络指标 hw.network.*
物理网络接口或网络接口控制器(NIC),不包括基于软件的虚拟适配器和环回。例如,服务器、交换机、路由器或防火墙上的物理网络接口、HBA、光纤通道端口或 Wi-Fi 适配器。
hw.type 必须设置为 "network"。
所有网络指标都可以包含以下属性
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
指标: hw.errors (网络)
此指标是推荐的。
网络适配器遇到的错误数量。
使用此指标时,必须设置以下属性
hw.type必须设置为"network",以指示错误来自网络适配器。
应设置以下属性
error.type应设置为指示错误类型,例如"zero_buffer_credit"、"crc"等。hw.network.direction应设置为指示错误的发生方向,为"receive"或"transmit"。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.errors | Counter | {error} | 组件遇到的错误数量。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.type | 必需 | 字符串 | 组件类型 [1] | battery; cpu; disk_controller | |
error.type | 有条件必填,仅当发生错误时 | 字符串 | 组件遇到的错误类型。[2] | uncorrected; zero_buffer_credit; crc; bad_sector | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
network.io.direction | 推荐 | 字符串 | 网络错误的网络流量方向。[3] | receive; transmit |
[1] hw.type: 描述了报告 hw.state 的硬件组件的类别。例如,hw.type=temperature 和 hw.state=degraded 将表示硬件组件的温度被报告为 degraded。
[2] error.type: error.type 应与组件报告的错误代码、错误的规范名称或其他低基数错误标识符相匹配。仪器化应记录其报告的错误列表。
[3] network.io.direction: 此属性仅在 hw.type 设置为 "network" 时使用,以指示错误的发生方向。
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
hw.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
battery | Battery | |
cpu | CPU | |
disk_controller | 磁盘控制器 | |
enclosure | Enclosure | |
fan | Fan | |
gpu | GPU | |
logical_disk | 逻辑磁盘 | |
memory | Memory | |
network | 网络 | |
physical_disk | 物理磁盘 | |
power_supply | 电源 | |
tape_drive | 磁带机 | |
temperature | Temperature | |
voltage | Voltage |
network.io.direction 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
receive | receive | |
transmit | transmit |
指标: hw.network.bandwidth.limit
此指标是推荐的。
链路速度。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.network.bandwidth.limit | UpDownCounter | Byte/s | 链路速度。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
指标: hw.network.bandwidth.utilization
此指标是推荐的。
网络带宽利用率,以分数表示。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.network.bandwidth.utilization | Gauge | 1 | 网络带宽利用率,以分数表示。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
指标: hw.network.io
此指标是推荐的。
接收和传输的网络流量(字节)。
使用此指标时,必须设置以下属性
hw.network.direction必须设置为以下值之一"receive": 接收到的网络流量量。"transmit": 传输的网络流量量。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.network.io | Counter | 每个调用的最大内存使用量的分布。 | 接收和传输的网络流量(字节)。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
network.io.direction | 必需 | 字符串 | 网络 IO 操作方向。 | receive; transmit | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
network.io.direction 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
receive | receive | |
transmit | transmit |
指标: hw.network.packets
此指标是推荐的。
接收和传输的网络流量(数据包或帧)。
使用此指标时,必须设置以下属性
hw.network.direction必须设置为以下值之一"receive": 接收到的数据包数量。"transmit": 传输的数据包数量。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.network.packets | Counter | {packet} | 接收和传输的网络流量(数据包或帧)。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
network.io.direction | 必需 | 字符串 | 网络 IO 操作方向。 | receive; transmit | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
network.io.direction 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
receive | receive | |
transmit | transmit |
指标: hw.network.up
此指标是推荐的。
链路状态:1(up)或 0(down)。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.network.up | UpDownCounter | 1 | 链路状态:1(up)或 0(down)。 |
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.model | 推荐 | 字符串 | 硬件组件的描述性型号名称 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.network.logical_addresses | 推荐 | string[] | 适配器的逻辑地址(例如,IP 地址或 WWPN) | ["172.16.8.21", "57.11.193.42"] | |
hw.network.physical_address | 推荐 | 字符串 | 适配器的物理地址(例如,MAC 地址或 WWNN) | 00-90-F5-E9-7B-36 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 | |
hw.serial_number | 推荐 | 字符串 | 硬件组件的序列号 | CNFCP0123456789 | |
hw.vendor | 推荐 | 字符串 | 硬件组件的供应商名称 | Dell; HP; Intel; AMD; LSI; Lenovo |
指标: hw.status (网络)
此指标是推荐的。
运行状态,与链路状态无关:对于每个可能的状态,1(true)或 0(false)。
使用此指标描述网络状态时,必须设置以下属性
hw.type必须设置为"network",以指示状态是针对网络适配器的。hw.state必须设置为以下值之一,以指示网络适配器状态"ok": 网络适配器正常运行。"degraded": 网络适配器运行功能或性能下降。"failed": 网络适配器已失效,无法运行。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
hw.status | UpDownCounter | 1 | 运行状态:对于每种可能的状态,为 1(true)或 0(false)。[1] |
[1]: hw.status 目前被指定为 UpDownCounter,但理想情况下应使用 StateSet(如 OpenMetrics 中定义的) 来表示。一旦 StateSet 在 OpenTelemetry 中被指定,此语义约定将进行更新。此计划的更改预计不会对用户查询其时间序列后端以检索 hw.status 值的方式产生任何影响。
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
hw.id | 必需 | 字符串 | 硬件组件的标识符,在监控主机内是唯一的 | win32battery_battery_testsysa33_1 | |
hw.state | 必需 | 字符串 | 组件的当前状态 | degraded; failed; needs_cleaning | |
hw.type | 必需 | 字符串 | 组件类型 [1] | battery; cpu; disk_controller | |
hw.name | 推荐 | 字符串 | 硬件组件的一个易于识别的名称 | eth0 | |
hw.parent | 推荐 | 字符串 | 父组件的唯一标识符(通常是机箱或磁盘控制器的 hw.id 属性) | dellStorage_perc_0 |
[1] hw.type: 描述了报告 hw.state 的硬件组件的类别。例如,hw.type=temperature 和 hw.state=degraded 将表示硬件组件的温度被报告为 degraded。
hw.state 具有以下已知值列表。如果其中一个适用,则必须使用相应的;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
degraded | 降级 | |
failed | 失败 | |
needs_cleaning | 需要清洁 | |
ok | OK | |
predicted_failure | 预测失败 |
hw.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
battery | Battery | |
cpu | CPU | |
disk_controller | 磁盘控制器 | |
enclosure | Enclosure | |
fan | Fan | |
gpu | GPU | |
logical_disk | 逻辑磁盘 | |
memory | Memory | |
network | 网络 | |
physical_disk | 物理磁盘 | |
power_supply | 电源 | |
tape_drive | 磁带机 | |
temperature | Temperature | |
voltage | Voltage |