Semantic conventions for logical disk metrics

Status: Development

• Logical disk metrics hw.logical_disk.*
  • Metric: hw.errors (Logical Disk)
  • Metric: hw.logical_disk.limit
  • Metric: hw.logical_disk.usage
  • Metric: hw.logical_disk.utilization
  • Metric: hw.status (Logical Disk)

Logical disk metrics hw.logical_disk.*

Storage extent presented as a physical disk by a disk controller to the operating system (e.g. a RAID 1 set made of 2 disks, and exposed as /dev/hdd0 by the controller).

Metric: hw.errors (Logical Disk)

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.errors	Counter	{error}	Number of errors encountered on this logical disk.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
hw.id		Required	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1
hw.type		Required	string	Type of the component [1]	logical_disk
error.type		Conditionally Required if and only if an error has occurred	string	The type of error encountered by the component. [2]	uncorrected; zero_buffer_credit; crc; bad_sector
hw.logical_disk.raid_level		Recommended	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10
hw.name		Recommended	string	An easily-recognizable name for the hardware component	eth0
hw.parent		Recommended	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0

[1] hw.type: MUST be set to logical_disk.

[2] error.type: The error.type SHOULD match the error code reported by the component, the canonical name of the error, or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report.

---

error.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
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

---

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

Metric: hw.logical_disk.limit

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.logical_disk.limit	UpDownCounter	By	Size of the logical disk.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
hw.id		Required	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1
hw.logical_disk.raid_level		Recommended	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10
hw.name		Recommended	string	An easily-recognizable name for the hardware component	eth0
hw.parent		Recommended	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0

Metric: hw.logical_disk.usage

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.logical_disk.usage	UpDownCounter	By	Logical disk space usage.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
hw.id		Required	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1
hw.logical_disk.state		Required	string	State of the logical disk space usage	used; free
hw.logical_disk.raid_level		Recommended	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10
hw.name		Recommended	string	An easily-recognizable name for the hardware component	eth0
hw.parent		Recommended	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0

---

hw.logical_disk.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
free	Free
used	Used

Metric: hw.logical_disk.utilization

This metric is recommended.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.logical_disk.utilization	Gauge	1	Logical disk space utilization as a fraction.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
hw.id		Required	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1
hw.logical_disk.state		Required	string	State of the logical disk space usage	used; free
hw.logical_disk.raid_level		Recommended	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10
hw.name		Recommended	string	An easily-recognizable name for the hardware component	eth0
hw.parent		Recommended	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0

---

hw.logical_disk.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
free	Free
used	Used

Metric: hw.status (Logical Disk)

This metric is recommended.

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.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
hw.id		Required	string	An identifier for the hardware component, unique within the monitored host	win32battery_battery_testsysa33_1
hw.state		Required	string	The current state of the component [1]	ok; degraded; failed
hw.type		Required	string	Type of the component [2]	logical_disk
hw.logical_disk.raid_level		Recommended	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10
hw.name		Recommended	string	An easily-recognizable name for the hardware component	eth0
hw.parent		Recommended	string	Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)	dellStorage_perc_0

[1] hw.state: MUST be set to one of the following values:

• ok: The logical disk is operating normally.
• degraded: The logical disk is operating with reduced functionality or performance.
• failed: The logical disk has failed and is not operational.

[2] hw.type: MUST be set to logical_disk.

---

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