diff --git a/docs/attributes-registry/system.md b/docs/attributes-registry/system.md index 73ac3757bc..a7db5e3fb9 100644 --- a/docs/attributes-registry/system.md +++ b/docs/attributes-registry/system.md @@ -54,6 +54,7 @@ | `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `buffers` | buffers | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cached` | cached | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `shared` | shared | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, report shared memory usage with `metric.system.memory.shared` metric | ## Paging attributes diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 423c52c077..0938fbbe08 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -30,6 +30,7 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam - [Memory Metrics](#memory-metrics) - [Metric: `system.memory.usage`](#metric-systemmemoryusage) - [Metric: `system.memory.limit`](#metric-systemmemorylimit) + - [Metric: `system.memory.shared`](#metric-systemmemoryshared) - [Metric: `system.memory.utilization`](#metric-systemmemoryutilization) - [Paging/Swap Metrics](#pagingswap-metrics) - [Metric: `system.paging.usage`](#metric-systempagingusage) @@ -204,6 +205,7 @@ available on the system, that is `system.memory.limit`. | `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `buffers` | buffers | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cached` | cached | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `shared` | shared | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, report shared memory usage with `metric.system.memory.shared` metric | ### Metric: `system.memory.limit` @@ -228,7 +230,7 @@ This metric is [opt-in][MetricOptIn]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `system.memory.shared` | UpDownCounter | `By` | Reports shared memory. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `system.memory.shared` | UpDownCounter | `By` | Reports shared memory. Memory used (mostly) by tmpfs. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -257,6 +259,7 @@ This metric is [recommended][MetricRecommended]. | `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `buffers` | buffers | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cached` | cached | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `shared` | shared | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Removed, report shared memory usage with `metric.system.memory.shared` metric | ## Paging/Swap Metrics diff --git a/model/metrics/system-metrics.yaml b/model/metrics/system-metrics.yaml index 73cdeaa22b..d4abffc4da 100644 --- a/model/metrics/system-metrics.yaml +++ b/model/metrics/system-metrics.yaml @@ -81,7 +81,7 @@ groups: type: metric metric_name: system.memory.shared stability: experimental - brief: "Reports shared memory." + brief: "Reports shared memory. Memory used (mostly) by tmpfs." instrument: updowncounter unit: "By" diff --git a/model/registry/system.yaml b/model/registry/system.yaml index 8033918537..9f64cc4519 100644 --- a/model/registry/system.yaml +++ b/model/registry/system.yaml @@ -71,6 +71,10 @@ groups: - id: cached value: 'cached' stability: experimental + - id: shared + value: 'shared' + stability: experimental + deprecated: 'Removed, report shared memory usage with `metric.system.memory.shared` metric' stability: experimental brief: "The memory state" examples: ["free", "cached"]