# Semantic conventions for enclosure metrics LLMS index: [llms.txt](/llms.txt) --- **Status**: [Development][DocumentStatus] ## 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: **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.bios_version`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | BIOS version of the hardware component | `1.2.3` | | [`hw.enclosure.type`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Type of the enclosure (useful for modular systems) | `Computer`; `Storage`; `Switch` | | [`hw.model`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Descriptive model name of the hardware component | `PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery` | | [`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.serial_number`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Serial number of the hardware component | `CNFCP0123456789` | | [`hw.vendor`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Vendor name of the hardware component | `Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo` | ### Metric: `hw.status` (Enclosure) This metric is [recommended][MetricRecommended]. 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] | ![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 | `degraded`; `failed`; `needs_cleaning` | | [`hw.type`](/docs/specs/semconv/registry/attributes/hardware.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | | [`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`:** 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 | ![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