# Semantic conventions for logical disk metrics LLMS index: [llms.txt](/llms.txt) --- **Status**: [Development][DocumentStatus] - [Logical disk metrics `hw.logical_disk.*`](#logical-disk-metrics-hwlogical_disk) - [Metric: `hw.errors` (Logical Disk)](#metric-hwerrors-logical-disk) - [Metric: `hw.logical_disk.limit`](#metric-hwlogical_disklimit) - [Metric: `hw.logical_disk.usage`](#metric-hwlogical_diskusage) - [Metric: `hw.logical_disk.utilization`](#metric-hwlogical_diskutilization) - [Metric: `hw.status` (Logical Disk)](#metric-hwstatus-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][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `hw.errors` | Counter | `{error}` | Number of errors encountered on this logical disk. | ![Development](https://img.shields.io/badge/-development-blue) | | **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`hw.id`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | | [`hw.type`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | Type of the component [1] | `logical_disk` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `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`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | | [`hw.name`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | An easily-recognizable name for the hardware component | `eth0` | | [`hw.parent`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `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. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `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 | ![Development](https://img.shields.io/badge/-development-blue) | | `cpu` | CPU | ![Development](https://img.shields.io/badge/-development-blue) | | `disk_controller` | Disk controller | ![Development](https://img.shields.io/badge/-development-blue) | | `enclosure` | Enclosure | ![Development](https://img.shields.io/badge/-development-blue) | | `fan` | Fan | ![Development](https://img.shields.io/badge/-development-blue) | | `gpu` | GPU | ![Development](https://img.shields.io/badge/-development-blue) | | `logical_disk` | Logical disk | ![Development](https://img.shields.io/badge/-development-blue) | | `memory` | Memory | ![Development](https://img.shields.io/badge/-development-blue) | | `network` | Network | ![Development](https://img.shields.io/badge/-development-blue) | | `physical_disk` | Physical disk | ![Development](https://img.shields.io/badge/-development-blue) | | `power_supply` | Power supply | ![Development](https://img.shields.io/badge/-development-blue) | | `tape_drive` | Tape drive | ![Development](https://img.shields.io/badge/-development-blue) | | `temperature` | Temperature | ![Development](https://img.shields.io/badge/-development-blue) | | `voltage` | Voltage | ![Development](https://img.shields.io/badge/-development-blue) | ### Metric: `hw.logical_disk.limit` This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `hw.logical_disk.limit` | UpDownCounter | `By` | Size of the logical disk. | ![Development](https://img.shields.io/badge/-development-blue) | | **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`hw.id`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | | [`hw.logical_disk.raid_level`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | | [`hw.name`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | An easily-recognizable name for the hardware component | `eth0` | | [`hw.parent`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `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][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `hw.logical_disk.usage` | UpDownCounter | `By` | Logical disk space usage. | ![Development](https://img.shields.io/badge/-development-blue) | | **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`hw.id`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | | [`hw.logical_disk.state`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | State of the logical disk space usage | `used`; `free` | | [`hw.logical_disk.raid_level`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | | [`hw.name`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | An easily-recognizable name for the hardware component | `eth0` | | [`hw.parent`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `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 | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | Used | ![Development](https://img.shields.io/badge/-development-blue) | ### Metric: `hw.logical_disk.utilization` This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations | | -------- | --------------- | ----------- | -------------- | --------- | ------ | | `hw.logical_disk.utilization` | Gauge | `1` | Logical disk space utilization as a fraction. | ![Development](https://img.shields.io/badge/-development-blue) | | **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`hw.id`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | | [`hw.logical_disk.state`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | State of the logical disk space usage | `used`; `free` | | [`hw.logical_disk.raid_level`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | | [`hw.name`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | An easily-recognizable name for the hardware component | `eth0` | | [`hw.parent`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `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 | ![Development](https://img.shields.io/badge/-development-blue) | | `used` | Used | ![Development](https://img.shields.io/badge/-development-blue) | ### Metric: `hw.status` (Logical Disk) This metric is [recommended][MetricRecommended]. | 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] | ![Development](https://img.shields.io/badge/-development-blue) | | **[1]:** `hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a [*StateSet* as defined in OpenMetrics](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset). 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](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`hw.id`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | | [`hw.state`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The current state of the component [1] | `ok`; `degraded`; `failed` | | [`hw.type`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | Type of the component [2] | `logical_disk` | | [`hw.logical_disk.raid_level`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | | [`hw.name`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | An easily-recognizable name for the hardware component | `eth0` | | [`hw.parent`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `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 | ![Development](https://img.shields.io/badge/-development-blue) | | `failed` | Failed | ![Development](https://img.shields.io/badge/-development-blue) | | `needs_cleaning` | Needs Cleaning | ![Development](https://img.shields.io/badge/-development-blue) | | `ok` | OK | ![Development](https://img.shields.io/badge/-development-blue) | | `predicted_failure` | Predicted Failure | ![Development](https://img.shields.io/badge/-development-blue) | --- `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 | ![Development](https://img.shields.io/badge/-development-blue) | | `cpu` | CPU | ![Development](https://img.shields.io/badge/-development-blue) | | `disk_controller` | Disk controller | ![Development](https://img.shields.io/badge/-development-blue) | | `enclosure` | Enclosure | ![Development](https://img.shields.io/badge/-development-blue) | | `fan` | Fan | ![Development](https://img.shields.io/badge/-development-blue) | | `gpu` | GPU | ![Development](https://img.shields.io/badge/-development-blue) | | `logical_disk` | Logical disk | ![Development](https://img.shields.io/badge/-development-blue) | | `memory` | Memory | ![Development](https://img.shields.io/badge/-development-blue) | | `network` | Network | ![Development](https://img.shields.io/badge/-development-blue) | | `physical_disk` | Physical disk | ![Development](https://img.shields.io/badge/-development-blue) | | `power_supply` | Power supply | ![Development](https://img.shields.io/badge/-development-blue) | | `tape_drive` | Tape drive | ![Development](https://img.shields.io/badge/-development-blue) | | `temperature` | Temperature | ![Development](https://img.shields.io/badge/-development-blue) | | `voltage` | Voltage | ![Development](https://img.shields.io/badge/-development-blue) | [DocumentStatus]: /docs/specs/otel/document-status [MetricRecommended]: /docs/specs/semconv/general/metric-requirement-level.md#recommended