move all hardware metrics to their own yaml files (#2380)

Author: trisch-me

.chloggen/hw_battery.yaml

@@ -0,0 +1,22 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: hardware
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Move text hardware metrics to the hardware components, yaml and md files
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [2380]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

.github/workflows/reusable-link-check.yml

@@ -26,7 +26,8 @@ jobs:
         run: |
           merge_base=$(git merge-base origin/${{ github.base_ref }} HEAD)
           # Using lychee's default extension filter here to match when it runs against all files
-          modified_files=$(git diff --name-only $merge_base...${{ github.event.pull_request.head.sha }} \
+          # --diff-filter=d excludes deleted files
+          modified_files=$(git diff --name-only --diff-filter=d $merge_base...${{ github.event.pull_request.head.sha }} \
                             | grep -E '\.(md|mkd|mdx|mdown|mdwn|mkdn|mkdown|markdown|html|htm|txt)$' \
                             | tr '\n' ' ' || true)
           echo "files=$modified_files" >> $GITHUB_OUTPUT

docs/general/metrics.md

@@ -30,7 +30,7 @@ The following semantic conventions surrounding metrics are defined:
 * **System metrics**
   * [System](/docs/system/system-metrics.md): For standard system metrics.
   * [Container](/docs/system/container-metrics.md)
-  * [Hardware](/docs/system/hardware-metrics.md): For hardware-related metrics.
+  * [Hardware](/docs/hardware/README.md): For hardware-related metrics.
   * [K8s](/docs/system/k8s-metrics.md): For K8s metrics.
   * [Process](/docs/system/process-metrics.md): For standard process metrics.
   * [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics.

docs/hardware/README.md

@@ -14,5 +14,19 @@ Semantic conventions for hardware are defined as following:
 
 * [Common Hardware Metrics](common.md): Semantic Conventions for *common* hardware metrics.
 * [Physical Host Metrics](host.md): Semantic Conventions for *physical host* metrics.
+* [Battery Metrics](battery.md): Semantic Conventions for *battery* metrics.
+* [CPU Metrics](cpu.md): Semantic Conventions for *CPU* metrics.
+* [Disk Controller Metrics](disk-controller.md): Semantic Conventions for *disk controller* metrics.
+* [Enclosure Metrics](enclosure.md): Semantic Conventions for *enclosure* metrics.
+* [Fan Metrics](fan.md): Semantic Conventions for *fan* metrics.
+* [GPU Metrics](gpu.md): Semantic Conventions for *GPU* metrics.
+* [Logical Disk Metrics](logical-disk.md): Semantic Conventions for *logical disk* metrics.
+* [Memory Metrics](memory.md): Semantic Conventions for *memory* metrics.
+* [Network Metrics](network.md): Semantic Conventions for *network* metrics.
+* [Physical Disk Metrics](physical-disk.md): Semantic Conventions for *physical disk* metrics.
+* [Power Supply Metrics](power-supply.md): Semantic Conventions for *power supply* metrics.
+* [Tape Drive Metrics](tape-drive.md): Semantic Conventions for *tape drive* metrics.
+* [Temperature Metrics](temperature.md): Semantic Conventions for *temperature* metrics.
+* [Voltage Metrics](voltage.md): Semantic Conventions for *voltage* metrics.
 
 [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/hardware/battery.md

@@ -26,7 +26,7 @@ The below metrics apply to any type of hardware component.
 
 These common `hw.` metrics include the below attributes to describe the
 monitored component:
-<!-- semconv metric.hw.attributes -->
+<!-- semconv metric_attributes.hw.attributes -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -137,14 +137,17 @@ This metric is [recommended][MetricRecommended].
 |---|---|---|---|---|---|
 | [`hw.id`](/docs/registry/attributes/hardware.md) | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`hw.type`](/docs/registry/attributes/hardware.md) | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| [`error.type`](/docs/registry/attributes/error.md) | 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 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
+| [`error.type`](/docs/registry/attributes/error.md) | 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 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
 | [`hw.name`](/docs/registry/attributes/hardware.md) | string | An easily-recognizable name for the hardware component | `eth0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`hw.parent`](/docs/registry/attributes/hardware.md) | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
+| [`network.io.direction`](/docs/registry/attributes/network.md) | string | Direction of network traffic for network errors. [3] | `receive`; `transmit` | `Recommended` | ![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`.
 
 **[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.
@@ -174,6 +177,15 @@ This metric is [recommended][MetricRecommended].
 | `temperature` | Temperature | ![Development](https://img.shields.io/badge/-development-blue) |
 | `voltage` | Voltage | ![Development](https://img.shields.io/badge/-development-blue) |
 
+---
+
+`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 | ![Development](https://img.shields.io/badge/-development-blue) |
+| `transmit` | transmit | ![Development](https://img.shields.io/badge/-development-blue) |
+
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
@@ -251,7 +263,7 @@ This metric is [recommended][MetricRecommended].
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
 | [`hw.id`](/docs/registry/attributes/hardware.md) | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| [`hw.state`](/docs/registry/attributes/hardware.md) | string | The current state of the component | `ok`; `degraded`; `failed` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| [`hw.state`](/docs/registry/attributes/hardware.md) | string | The current state of the component | `degraded`; `failed`; `needs_cleaning` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`hw.type`](/docs/registry/attributes/hardware.md) | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`hw.name`](/docs/registry/attributes/hardware.md) | string | An easily-recognizable name for the hardware component | `eth0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
 | [`hw.parent`](/docs/registry/attributes/hardware.md) | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
@@ -266,7 +278,9 @@ This metric is [recommended][MetricRecommended].
 |---|---|---|
 | `degraded` | Degraded | ![Development](https://img.shields.io/badge/-development-blue) |
 | `failed` | Failed | ![Development](https://img.shields.io/badge/-development-blue) |
-| `ok` | Ok | ![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) |
 
 ---