Semantic conventions for enclosure metrics

Status: Development

Enclosure metrics hw.enclosure.*

Computer chassis (can be an expansion enclosure).

hw.type MUST be set to "enclosure".

All enclosure 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.bios_version	string	BIOS version of the hardware component	1.2.3	Recommended
hw.enclosure.type	string	Type of the enclosure (useful for modular systems)	Computer; Storage; Switch	Recommended
hw.model	string	Descriptive model name of the hardware component	PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery	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.serial_number	string	Serial number of the hardware component	CNFCP0123456789	Recommended
hw.vendor	string	Vendor name of the hardware component	Dell; HP; Intel; AMD; LSI; Lenovo	Recommended

Metric: hw.status (Enclosure)

This metric is recommended.

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

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

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

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