50 lines
3.5 KiB
Markdown
50 lines
3.5 KiB
Markdown
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
|
|
|
|
# Hardware
|
|
|
|
## Hardware Attributes
|
|
|
|
Attributes for hardware.
|
|
|
|
| Attribute | Type | Description | Examples | Stability |
|
|
|---|---|---|---|---|
|
|
| <a id="hw-id" href="#hw-id">`hw.id`</a> | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` |  |
|
|
| <a id="hw-name" href="#hw-name">`hw.name`</a> | string | An easily-recognizable name for the hardware component | `eth0` |  |
|
|
| <a id="hw-parent" href="#hw-parent">`hw.parent`</a> | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` |  |
|
|
| <a id="hw-state" href="#hw-state">`hw.state`</a> | string | The current state of the component | `ok`; `degraded`; `failed` |  |
|
|
| <a id="hw-type" href="#hw-type">`hw.type`</a> | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` |  |
|
|
|
|
**[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 |  |
|
|
| `ok` | Ok |  |
|
|
|
|
---
|
|
|
|
`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 |  |
|