Skip to content

Commit

Permalink
Merge branch 'main' into code-stacktrace
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWert committed Oct 27, 2023
2 parents 8ad9fe2 + 131637a commit a09952a
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 6 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ release.
([#429](https://github.com/open-telemetry/semantic-conventions/pull/429))
- Use seconds as default duration for FaaS duration histograms
([#384](https://github.com/open-telemetry/semantic-conventions/pull/384))
- BREAKING: Remove `total` from list of well-known values of `system.memory.state` attribute.
([#409](https://github.com/open-telemetry/semantic-conventions/pull/409))

### Features

- Adds `session.previous_id` to session.md
([#348](https://github.com/open-telemetry/semantic-conventions/pull/348))
- Metric namespaces SHOULD NOT be pluralized.
([#267](https://github.com/open-telemetry/opentelemetry-specification/pull/267))
- Add opt-in `system.memory.limit` metric.
([#409](https://github.com/open-telemetry/semantic-conventions/pull/409))

### Fixes

Expand Down
24 changes: 21 additions & 3 deletions docs/system/system-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam
* [Metric: `system.cpu.frequency`](#metric-systemcpufrequency)
- [Memory Metrics](#memory-metrics)
* [Metric: `system.memory.usage`](#metric-systemmemoryusage)
* [Metric: `system.memory.limit`](#metric-systemmemorylimit)
* [Metric: `system.memory.utilization`](#metric-systemmemoryutilization)
- [Paging/Swap Metrics](#pagingswap-metrics)
* [Metric: `system.paging.usage`](#metric-systempagingusage)
Expand Down Expand Up @@ -174,7 +175,10 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.memory.usage(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `system.memory.usage` | UpDownCounter | `By` | |
| `system.memory.usage` | UpDownCounter | `By` | Reports memory in use by state. [1] |

**[1]:** The sum over all `system.memory.state` values SHOULD equal the total memory
available on the system, that is `system.memory.limit`.
<!-- endsemconv -->

<!-- semconv metric.system.memory.usage(full) -->
Expand All @@ -186,14 +190,28 @@ This metric is [recommended][MetricRecommended].

| Value | Description |
|---|---|
| `total` | total |
| `used` | used |
| `free` | free |
| `shared` | shared |
| `buffers` | buffers |
| `cached` | cached |
<!-- endsemconv -->

### Metric: `system.memory.limit`

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

<!-- semconv metric.system.memory.limit(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `system.memory.limit` | UpDownCounter | `By` | Total memory available in the system. [1] |

**[1]:** Its value SHOULD equal the sum of `system.memory.state` over all states.
<!-- endsemconv -->

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

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

This metric is [recommended][MetricRecommended].
Expand All @@ -213,7 +231,6 @@ This metric is [recommended][MetricRecommended].

| Value | Description |
|---|---|
| `total` | total |
| `used` | used |
| `free` | free |
| `shared` | shared |
Expand Down Expand Up @@ -769,6 +786,7 @@ an `{os}` prefix to split this metric across OSes.

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
[MetricRecommended]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/metrics/metric-requirement-level.md#recommended
[MetricOptIn]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/metrics/metric-requirement-level.md#opt-in

### Metric: `system.linux.memory.available`

Expand Down
16 changes: 13 additions & 3 deletions model/metrics/system-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,6 @@ groups:
type:
allow_custom_values: true
members:
- id: total
value: 'total'
- id: used
value: 'used'
- id: free
Expand All @@ -114,12 +112,24 @@ groups:
- id: metric.system.memory.usage
type: metric
metric_name: system.memory.usage
brief: ""
brief: "Reports memory in use by state."
note: |
The sum over all `system.memory.state` values SHOULD equal the total memory
available on the system, that is `system.memory.limit`.
instrument: updowncounter
unit: "By"
attributes:
- ref: system.memory.state

- id: metric.system.memory.limit
type: metric
metric_name: system.memory.limit
brief: "Total memory available in the system."
note: |
Its value SHOULD equal the sum of `system.memory.state` over all states.
instrument: updowncounter
unit: "By"

- id: metric.system.memory.utilization
type: metric
metric_name: system.memory.utilization
Expand Down

0 comments on commit a09952a

Please sign in to comment.