From e2284b825a4903bfd743d68be67a7d3918556ca2 Mon Sep 17 00:00:00 2001
From: Roger Coll <rogercoll@protonmail.com>
Date: Mon, 2 Sep 2024 16:25:45 +0200
Subject: [PATCH] Add the system.disk.limit metric (#1356)

---
 .chloggen/add_system_disk_limit.yaml | 22 ++++++++++++++++
 docs/system/system-metrics.md        | 39 ++++++++++++++++++++++++++++
 model/metrics/system-metrics.yaml    | 10 +++++++
 3 files changed, 71 insertions(+)
 create mode 100755 .chloggen/add_system_disk_limit.yaml

diff --git a/.chloggen/add_system_disk_limit.yaml b/.chloggen/add_system_disk_limit.yaml
new file mode 100755
index 0000000000..51d8b29b17
--- /dev/null
+++ b/.chloggen/add_system_disk_limit.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: system
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add the `system.disk.limit` metric
+
+# 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: [127]
+
+# (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:
diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md
index a2c8633899..c91f822e31 100644
--- a/docs/system/system-metrics.md
+++ b/docs/system/system-metrics.md
@@ -43,6 +43,7 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam
   - [Metric: `system.disk.io_time`](#metric-systemdiskio_time)
   - [Metric: `system.disk.operation_time`](#metric-systemdiskoperation_time)
   - [Metric: `system.disk.merged`](#metric-systemdiskmerged)
+  - [Metric: `system.disk.limit`](#metric-systemdisklimit)
 - [Filesystem Metrics](#filesystem-metrics)
   - [Metric: `system.filesystem.usage`](#metric-systemfilesystemusage)
   - [Metric: `system.filesystem.utilization`](#metric-systemfilesystemutilization)
@@ -916,6 +917,44 @@ This metric is [recommended][MetricRecommended].
 
 
 
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- END AUTOGENERATED TEXT -->
+<!-- endsemconv -->
+
+### Metric: `system.disk.limit`
+
+This metric is [opt-in][MetricOptIn].
+
+<!-- semconv metric.system.disk.limit(metric_table) -->
+<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/snippet.md.j2 -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable -->
+
+| Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
+| -------- | --------------- | ----------- | -------------- | --------- |
+| `system.disk.limit` | UpDownCounter | `By` | The total storage capacity of the disk | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- END AUTOGENERATED TEXT -->
+<!-- endsemconv -->
+
+<!-- semconv metric.system.disk.limit -->
+<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/snippet.md.j2 -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable -->
+
+| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
+|---|---|---|---|---|---|
+| [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
diff --git a/model/metrics/system-metrics.yaml b/model/metrics/system-metrics.yaml
index 9784deeece..33b94a3ff0 100644
--- a/model/metrics/system-metrics.yaml
+++ b/model/metrics/system-metrics.yaml
@@ -209,6 +209,16 @@ groups:
       - ref: system.device
       - ref: disk.io.direction
 
+  - id: metric.system.disk.limit
+    type: metric
+    metric_name: system.disk.limit
+    stability: experimental
+    brief: "The total storage capacity of the disk"
+    instrument: updowncounter
+    unit: "By"
+    attributes:
+      - ref: system.device
+
   # system.filesystem.* metrics
   - id: metric.system.filesystem.usage
     type: metric