Skip to content

Commit

Permalink
[metrics/system] Remove shared from system.memory.state values
Browse files Browse the repository at this point in the history
Signed-off-by: ChrsMark <[email protected]>
  • Loading branch information
ChrsMark committed Apr 18, 2024
1 parent ac9f85f commit fcbab37
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 6 deletions.
22 changes: 22 additions & 0 deletions .chloggen/decouple_shared_memory_metric.yaml
Original file line number Diff line number Diff line change
@@ -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: 'breaking'

# 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: Remove `shared` from `system.memory.state` values and make it a standalone 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: [522]

# (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:
1 change: 0 additions & 1 deletion docs/attributes-registry/system.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
|---|---|---|
| `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `shared` | shared | ![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) |
<!-- endsemconv -->
Expand Down
15 changes: 13 additions & 2 deletions docs/system/system-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ available on the system, that is `system.memory.limit`.
|---|---|---|
| `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `shared` | shared | ![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) |
<!-- endsemconv -->
Expand All @@ -222,6 +221,19 @@ This metric is [opt-in][MetricOptIn].
<!-- semconv metric.system.memory.limit(full) -->
<!-- endsemconv -->

### Metric: `system.memory.shared`

This metric is [opt-in][MetricOptIn].

<!-- semconv metric.system.memory.shared(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `system.memory.shared` | UpDownCounter | `By` | Reports shared memory. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

<!-- semconv metric.system.memory.shared(full) -->
<!-- endsemconv -->

### Metric: `system.memory.utilization`

This metric is [recommended][MetricRecommended].
Expand All @@ -243,7 +255,6 @@ This metric is [recommended][MetricRecommended].
|---|---|---|
| `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `shared` | shared | ![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) |
<!-- endsemconv -->
Expand Down
8 changes: 8 additions & 0 deletions model/metrics/system-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ groups:
unit: "By"
attributes: []

- id: metric.system.memory.shared
type: metric
metric_name: system.memory.shared
stability: experimental
brief: "Reports shared memory."
instrument: updowncounter
unit: "By"

- id: metric.system.memory.utilization
type: metric
metric_name: system.memory.utilization
Expand Down
3 changes: 0 additions & 3 deletions model/registry/system.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ groups:
- id: free
value: 'free'
stability: experimental
- id: shared
value: 'shared'
stability: experimental
- id: buffers
value: 'buffers'
stability: experimental
Expand Down

0 comments on commit fcbab37

Please sign in to comment.