open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/registry/attributes/hardware.md

136 lines
12 KiB
Markdown
Raw Blame History

<!-- 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-battery-capacity" href="#hw-battery-capacity">`hw.battery.capacity`</a> | string | Design capacity in Watts-hours or Amper-hours | `9.3Ah`; `50Wh` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-battery-chemistry" href="#hw-battery-chemistry">`hw.battery.chemistry`</a> | string | Battery [chemistry](https://schemas.dmtf.org/wbem/cim-html/2.31.0/CIM_Battery.html), e.g. Lithium-Ion, Nickel-Cadmium, etc. | `Li-ion`; `NiMH` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-battery-state" href="#hw-battery-state">`hw.battery.state`</a> | string | The current state of the battery | `charging`; `discharging` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-bios-version" href="#hw-bios-version">`hw.bios_version`</a> | string | BIOS version of the hardware component | `1.2.3` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-driver-version" href="#hw-driver-version">`hw.driver_version`</a> | string | Driver version for the hardware component | `10.2.1-3` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-enclosure-type" href="#hw-enclosure-type">`hw.enclosure.type`</a> | string | Type of the enclosure (useful for modular systems) | `Computer`; `Storage`; `Switch` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-firmware-version" href="#hw-firmware-version">`hw.firmware_version`</a> | string | Firmware version of the hardware component | `2.0.1` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-gpu-task" href="#hw-gpu-task">`hw.gpu.task`</a> | string | Type of task the GPU is performing | `decoder`; `encoder`; `general` | ![Development](https://img.shields.io/badge/-development-blue) |
| <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` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-limit-type" href="#hw-limit-type">`hw.limit_type`</a> | string | Type of limit for hardware components | `critical`; `degraded`; `high.critical` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-logical-disk-raid-level" href="#hw-logical-disk-raid-level">`hw.logical_disk.raid_level`</a> | string | RAID Level of the logical disk | `RAID0+1`; `RAID5`; `RAID10` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-logical-disk-state" href="#hw-logical-disk-state">`hw.logical_disk.state`</a> | string | State of the logical disk space usage | `used`; `free` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-memory-type" href="#hw-memory-type">`hw.memory.type`</a> | string | Type of the memory module | `DDR4`; `DDR5`; `LPDDR5` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-model" href="#hw-model">`hw.model`</a> | string | Descriptive model name of the hardware component | `PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-name" href="#hw-name">`hw.name`</a> | string | An easily-recognizable name for the hardware component | `eth0` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-network-logical-addresses" href="#hw-network-logical-addresses">`hw.network.logical_addresses`</a> | string[] | Logical addresses of the adapter (e.g. IP address, or WWPN) | `["172.16.8.21", "57.11.193.42"]` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-network-physical-address" href="#hw-network-physical-address">`hw.network.physical_address`</a> | string | Physical address of the adapter (e.g. MAC address, or WWNN) | `00-90-F5-E9-7B-36` | ![Development](https://img.shields.io/badge/-development-blue) |
| <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` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-physical-disk-smart-attribute" href="#hw-physical-disk-smart-attribute">`hw.physical_disk.smart_attribute`</a> | string | [S.M.A.R.T.](https://wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis, and Reporting Technology) attribute of the physical disk | `Spin Retry Count`; `Seek Error Rate`; `Raw Read Error Rate` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-physical-disk-state" href="#hw-physical-disk-state">`hw.physical_disk.state`</a> | string | State of the physical disk endurance utilization | `remaining` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-physical-disk-type" href="#hw-physical-disk-type">`hw.physical_disk.type`</a> | string | Type of the physical disk | `HDD`; `SSD`; `10K` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-sensor-location" href="#hw-sensor-location">`hw.sensor_location`</a> | string | Location of the sensor | `cpu0`; `ps1`; `INLET`; `CPU0_DIE`; `AMBIENT`; `MOTHERBOARD`; `PS0 V3_3`; `MAIN_12V`; `CPU_VCORE` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-serial-number" href="#hw-serial-number">`hw.serial_number`</a> | string | Serial number of the hardware component | `CNFCP0123456789` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-state" href="#hw-state">`hw.state`</a> | string | The current state of the component | `degraded`; `failed`; `needs_cleaning` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-tape-drive-operation-type" href="#hw-tape-drive-operation-type">`hw.tape_drive.operation_type`</a> | string | Type of tape drive operation | `mount`; `unmount`; `clean` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-type" href="#hw-type">`hw.type`</a> | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | ![Development](https://img.shields.io/badge/-development-blue) |
| <a id="hw-vendor" href="#hw-vendor">`hw.vendor`</a> | string | Vendor name of the hardware component | `Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo` | ![Development](https://img.shields.io/badge/-development-blue) |
**[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.battery.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 |
|---|---|---|
| `charging` | Charging | ![Development](https://img.shields.io/badge/-development-blue) |
| `discharging` | Discharging | ![Development](https://img.shields.io/badge/-development-blue) |
---
`hw.gpu.task` 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 |
|---|---|---|
| `decoder` | Decoder | ![Development](https://img.shields.io/badge/-development-blue) |
| `encoder` | Encoder | ![Development](https://img.shields.io/badge/-development-blue) |
| `general` | General | ![Development](https://img.shields.io/badge/-development-blue) |
---
`hw.limit_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 |
|---|---|---|
| `critical` | Critical | ![Development](https://img.shields.io/badge/-development-blue) |
| `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) |
| `high.critical` | High Critical | ![Development](https://img.shields.io/badge/-development-blue) |
| `high.degraded` | High Degraded | ![Development](https://img.shields.io/badge/-development-blue) |
| `low.critical` | Low Critical | ![Development](https://img.shields.io/badge/-development-blue) |
| `low.degraded` | Low Degraded | ![Development](https://img.shields.io/badge/-development-blue) |
| `max` | Maximum | ![Development](https://img.shields.io/badge/-development-blue) |
| `throttled` | Throttled | ![Development](https://img.shields.io/badge/-development-blue) |
| `turbo` | Turbo | ![Development](https://img.shields.io/badge/-development-blue) |
---
`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) |
---
`hw.physical_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 |
|---|---|---|
| `remaining` | Remaining | ![Development](https://img.shields.io/badge/-development-blue) |
---
`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.tape_drive.operation_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 |
|---|---|---|
| `clean` | Clean | ![Development](https://img.shields.io/badge/-development-blue) |
| `mount` | Mount | ![Development](https://img.shields.io/badge/-development-blue) |
| `unmount` | Unmount | ![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) |
Reference in New Issue View Git Blame Copy Permalink