Add registry md file for disk attributes (open-telemetry#555)

Signed-off-by: ChrsMark <[email protected]>
pyohannes · Jan 17, 2024 · cf53385 · cf53385
1 parent dff499b
commit cf53385
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -34,6 +34,7 @@ Currently, the following namespaces exist:
 * [DB](db.md) (database)
 * [Destination](destination.md)
 * [Device](device.md)
+* [Disk](disk.md)
 * [Error](error.md)
 * [Host](host.md)
 * [HTTP](http.md)

diff --git a/docs/attributes-registry/disk.md b/docs/attributes-registry/disk.md
@@ -0,0 +1,19 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+# Disk
+
+## Disk Attributes
+
+<!-- semconv registry.disk(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `disk.io.direction` | string | The disk IO operation direction. | `read` |
+
+`disk.io.direction` MUST be one of the following:
+
+| Value  | Description |
+|---|---|
+| `read` | read |
+| `write` | write |
+<!-- endsemconv -->
diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md
@@ -359,7 +359,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.system.disk.io(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `disk.io.direction` | string | The disk IO operation direction. | `read` | Recommended |
+| [`disk.io.direction`](../attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | Recommended |
 | `system.device` | string | The device identifier | `(identifier)` | Recommended |
 
 `disk.io.direction` MUST be one of the following:
@@ -383,7 +383,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.system.disk.operations(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `disk.io.direction` | string | The disk IO operation direction. | `read` | Recommended |
+| [`disk.io.direction`](../attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | Recommended |
 | `system.device` | string | The device identifier | `(identifier)` | Recommended |
 
 `disk.io.direction` MUST be one of the following:
@@ -435,7 +435,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.system.disk.operation_time(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `disk.io.direction` | string | The disk IO operation direction. | `read` | Recommended |
+| [`disk.io.direction`](../attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | Recommended |
 | `system.device` | string | The device identifier | `(identifier)` | Recommended |
 
 `disk.io.direction` MUST be one of the following:
@@ -459,7 +459,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.system.disk.merged(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `disk.io.direction` | string | The disk IO operation direction. | `read` | Recommended |
+| [`disk.io.direction`](../attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | Recommended |
 | `system.device` | string | The device identifier | `(identifier)` | Recommended |
 
 `disk.io.direction` MUST be one of the following: