Semantic conventions for logical disk metrics

Status: Development

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).

hw.type MUST be set to "logical_disk".

All logical disk 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.logical_disk.raid_level	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10	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

Metric: hw.errors (Logical Disk)

This metric is recommended.

Number of errors encountered on this logical disk.

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

• hw.type MUST be set to "logical_disk" to indicate that the errors are from a logical disk.

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
hw.errors	Counter	{error}	Number of errors encountered by the component.

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.type	string	Type of the component [1]	battery; cpu; disk_controller	Required
error.type	string	The type of error encountered by the component. [2]	uncorrected; zero_buffer_credit; crc; bad_sector	Conditionally Required if and only if an error has occurred
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
network.io.direction	string	Direction of network traffic for network errors. [3]	receive; transmit	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.

[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.

[3] network.io.direction: This attribute SHOULD only be used when hw.type is set to "network" to indicate the direction of the error.

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

network.io.direction 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
receive	receive
transmit	transmit

Metric: hw.logical_disk.limit

This metric is recommended.

Size of the logical disk.

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

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.logical_disk.raid_level	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10	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

Metric: hw.logical_disk.usage

This metric is recommended.

Logical disk space usage.

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

• hw.logical_disk.state MUST be set to one of the following values:
  • "used": The amount of disk space that is in use.
  • "free": The amount of disk space that is free.

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

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.logical_disk.state	string	State of the logical disk space usage	used; free	Required
hw.logical_disk.raid_level	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10	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.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.

Logical disk space utilization as a fraction.

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

• hw.logical_disk.state MUST be set to one of the following values:
  • "used": The fraction of disk space that is in use.
  • "free": The fraction of disk space that is free.

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

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.logical_disk.state	string	State of the logical disk space usage	used; free	Required
hw.logical_disk.raid_level	string	RAID Level of the logical disk	RAID0+1; RAID5; RAID10	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.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.

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

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

• hw.type MUST be set to "logical_disk" to indicate that the status is for a logical disk.
• hw.state MUST be set to one of the following values to indicate the logical disk state:
  • "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.

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