docs: add recommended metric requirement level

open-telemetry · Jun 4, 2024 · bd3fd25 · bd3fd25
1 parent a8cf5d4
commit bd3fd25
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md
@@ -1475,6 +1475,8 @@ See also `MemAvailable` in [/proc/meminfo](https://man7.org/linux/man-pages/man5
 
 ### Metric: `system.linux.memory.slab.usage`
 
+This metric is [recommended][MetricRecommended].
+
 <!-- semconv metric.system.linux.memory.slab.usage(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
@@ -1484,10 +1486,10 @@ See also `MemAvailable` in [/proc/meminfo](https://man7.org/linux/man-pages/man5
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `system.linux.memory.slab.usage` | UpDownCounter | `By` | Reports the memory used by the Linux kernel for managing caches of frequently used objects by state. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `system.linux.memory.slab.usage` | UpDownCounter | `By` | Reports the memory used by the Linux kernel for managing caches of frequently used objects. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
-**[1]:** The sum over all `system.linux.memory.slab.usage` state values SHOULD equal the total slab memory available on the system, that is `system.linux.memory.slab.limit`.
+**[1]:** The sum over all `system.linux.memory.slab.usage` state values SHOULD be equal to the total slab memory available on the system, that is `system.linux.memory.slab.limit`.
 
 
 
@@ -1523,6 +1525,8 @@ See also `MemAvailable` in [/proc/meminfo](https://man7.org/linux/man-pages/man5
 
 ### Metric: `system.linux.memory.slab.limit`
 
+This metric is [recommended][MetricRecommended].
+
 <!-- semconv metric.system.linux.memory.slab.limit(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
@@ -1535,7 +1539,7 @@ See also `MemAvailable` in [/proc/meminfo](https://man7.org/linux/man-pages/man5
 | `system.linux.memory.slab.limit` | UpDownCounter | `By` | Total slab memory used in the system. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
-**[1]:** Its value SHOULD equal the sum of `system.linux.memory.slab.usage` over all states.
+**[1]:** Its value SHOULD be equal to the sum of `system.linux.memory.slab.usage` over all states.