通用硬件指标的语义约定

状态: 开发中

硬件指标不包含标识其所报告设备的、机器的或主机的属性。此信息预计通过用户应用程序配置的资源属性提供。鼓励应用程序开发人员配置 Host 资源属性。

通用硬件指标

以下指标适用于任何类型的硬件组件。

这些通用的 hw. 指标包含以下属性来描述受监控的组件

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
hw.id		必需	字符串	硬件组件的标识符，在监控主机内是唯一的	win32battery_battery_testsysa33_1
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.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

指标: hw.energy

此指标是推荐的。

名称	Instrument Type	Unit (UCUM)	描述	Stability	实体关联
hw.energy	Counter	J	组件消耗的能量。

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
hw.id		必需	字符串	硬件组件的标识符，在监控主机内是唯一的	win32battery_battery_testsysa33_1
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.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

指标: hw.errors

此指标是推荐的。

名称	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.power

此指标是推荐的。

名称	Instrument Type	Unit (UCUM)	描述	Stability	实体关联
hw.power	Gauge	W	组件消耗的瞬时功率。[1]

[1]: 建议在可能的情况下报告 hw.energy 而不是 hw.power。

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
hw.id		必需	字符串	硬件组件的标识符，在监控主机内是唯一的	win32battery_battery_testsysa33_1
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.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

指标: hw.status

此指标是推荐的。

名称	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