semantic-conventions/docs/hardware/fan.md

Semantic conventions for fan metrics

Status: Development

• Fan metrics hw.fan.*
  • Metric: hw.fan.speed
  • Metric: hw.fan.speed.limit
  • Metric: hw.fan.speed_ratio
  • Metric: hw.status (Fan)

Fan metrics hw.fan.*

Fan that keeps the air flowing to maintain the internal temperature of a computer.

hw.type MUST be set to "fan".

All fan metrics may include the below attributes:

Attribute	Type	Description	Examples	Requirement Level	Stability
hw.id	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1	Required
hw.name	string	An easily-recognizable name for the hardware component	eth0	Recommended
hw.parent	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0	Recommended
hw.sensor_location	string	Location of the sensor	cpu0; ps1; INLET; CPU0_DIE; AMBIENT; MOTHERBOARD; PS0 V3_3; MAIN_12V; CPU_VCORE	Recommended

Metric: hw.fan.speed

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.fan.speed	Gauge	rpm	Fan speed in revolutions per minute.

Attribute	Type	Description	Examples	Requirement Level	Stability
hw.id	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1	Required
hw.name	string	An easily-recognizable name for the hardware component	eth0	Recommended
hw.parent	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0	Recommended
hw.sensor_location	string	Location of the sensor	cpu0; ps1; INLET; CPU0_DIE; AMBIENT; MOTHERBOARD; PS0 V3_3; MAIN_12V; CPU_VCORE	Recommended

Metric: hw.fan.speed.limit

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.fan.speed.limit	Gauge	rpm	Speed limit in rpm.

Attribute	Type	Description	Examples	Requirement Level	Stability
hw.id	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1	Required
hw.limit_type	string	Type of limit for hardware components	low.critical; low.degraded; max	Recommended
hw.name	string	An easily-recognizable name for the hardware component	eth0	Recommended
hw.parent	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0	Recommended
hw.sensor_location	string	Location of the sensor	cpu0; ps1; INLET; CPU0_DIE; AMBIENT; MOTHERBOARD; PS0 V3_3; MAIN_12V; CPU_VCORE	Recommended

---

hw.limit_type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
critical	Critical
degraded	Degraded
high.critical	High Critical
high.degraded	High Degraded
low.critical	Low Critical
low.degraded	Low Degraded
max	Maximum
throttled	Throttled
turbo	Turbo

Metric: hw.fan.speed_ratio

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.fan.speed_ratio	Gauge	1	Fan speed expressed as a fraction of its maximum speed.

Attribute	Type	Description	Examples	Requirement Level	Stability
hw.id	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1	Required
hw.name	string	An easily-recognizable name for the hardware component	eth0	Recommended
hw.parent	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0	Recommended
hw.sensor_location	string	Location of the sensor	cpu0; ps1; INLET; CPU0_DIE; AMBIENT; MOTHERBOARD; PS0 V3_3; MAIN_12V; CPU_VCORE	Recommended

Metric: hw.status (Fan)

This metric is recommended.

Operational status: 1 (true) or 0 (false) for each of the possible states.

When using this metric for fan status, the following attributes MUST be set:

• hw.type MUST be set to "fan" to indicate that the status is for a fan.
• hw.state MUST be set to one of the following values to indicate the fan state:
  • "ok": The fan is operating normally.
  • "degraded": The fan is operating with reduced functionality or performance.
  • "failed": The fan has failed and is not operational.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.status	UpDownCounter	1	Operational status: 1 (true) or 0 (false) for each of the possible states. [1]

[1]: hw.status is currently specified as an UpDownCounter but would ideally be represented using a StateSet as defined in OpenMetrics. This semantic convention will be updated once StateSet is specified in OpenTelemetry. This planned change is not expected to have any consequence on the way users query their timeseries backend to retrieve the values of hw.status over time.

Attribute	Type	Description	Examples	Requirement Level	Stability
hw.id	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1	Required
hw.state	string	The current state of the component	degraded; failed; needs_cleaning	Required
hw.type	string	Type of the component [1]	battery; cpu; disk_controller	Required
hw.name	string	An easily-recognizable name for the hardware component	eth0	Recommended
hw.parent	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0	Recommended

[1] hw.type: Describes the category of the hardware component for which hw.state is being reported. For example, hw.type=temperature along with hw.state=degraded would indicate that the temperature of the hardware component has been reported as degraded.

---

hw.state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
degraded	Degraded
failed	Failed
needs_cleaning	Needs Cleaning
ok	OK
predicted_failure	Predicted Failure

---

hw.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
battery	Battery
cpu	CPU
disk_controller	Disk controller
enclosure	Enclosure
fan	Fan
gpu	GPU
logical_disk	Logical disk
memory	Memory
network	Network
physical_disk	Physical disk
power_supply	Power supply
tape_drive	Tape drive
temperature	Temperature
voltage	Voltage