Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename jvm.buffer.(usage|limit) to jvm.buffer.memory.(usage|limit)
Browse files Browse the repository at this point in the history
trask committed Aug 14, 2023
1 parent 728c3ca commit e5f31e2
Showing 4 changed files with 21 additions and 16 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -48,6 +48,9 @@ release.
- Clarify that `http/dup` has higher precedence than `http` in case both values are present
in `OTEL_SEMCONV_STABILITY_OPT_IN`
([#249](https://github.com/open-telemetry/semantic-conventions/pull/249))
- Rename `jvm.buffer.usage` to `jvm.buffer.memory.usage`
and rename `jvm.buffer.limit` to `jvm.buffer.memory.limit`.
([#999](https://github.com/open-telemetry/semantic-conventions/pull/999))

## v1.21.0 (2023-07-13)

20 changes: 10 additions & 10 deletions docs/system/runtime-environment-metrics.md
Original file line number Diff line number Diff line change
@@ -35,8 +35,8 @@ semantic conventions when instrumenting runtime environments.
* [Metric: `jvm.memory.init`](#metric-jvmmemoryinit)
* [Metric: `jvm.system.cpu.utilization`](#metric-jvmsystemcpuutilization)
* [Metric: `jvm.system.cpu.load_1m`](#metric-jvmsystemcpuload_1m)
* [Metric: `jvm.buffer.usage`](#metric-jvmbufferusage)
* [Metric: `jvm.buffer.limit`](#metric-jvmbufferlimit)
* [Metric: `jvm.buffer.memory.usage`](#metric-jvmbuffermemoryusage)
* [Metric: `jvm.buffer.memory.limit`](#metric-jvmbuffermemorylimit)
* [Metric: `jvm.buffer.count`](#metric-jvmbuffercount)

<!-- tocstop -->
@@ -371,37 +371,37 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht
<!-- semconv metric.jvm.system.cpu.load_1m(full) -->
<!-- endsemconv -->

### Metric: `jvm.buffer.usage`
### Metric: `jvm.buffer.memory.usage`

This metric is [recommended][MetricRecommended].
This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/BufferPoolMXBean.html#getMemoryUsed--).

<!-- semconv metric.jvm.buffer.usage(metric_table) -->
<!-- semconv metric.jvm.buffer.memory.usage(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `jvm.buffer.usage` | UpDownCounter | `By` | Measure of memory used by buffers. |
| `jvm.buffer.memory.usage` | UpDownCounter | `By` | Measure of memory used by buffers. |
<!-- endsemconv -->

<!-- semconv metric.jvm.buffer.usage(full) -->
<!-- semconv metric.jvm.buffer.memory.usage(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | Recommended |

**[1]:** Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()).
<!-- endsemconv -->

### Metric: `jvm.buffer.limit`
### Metric: `jvm.buffer.memory.limit`

This metric is [recommended][MetricRecommended].
This metric is obtained from [`BufferPoolMXBean#getTotalCapacity()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/BufferPoolMXBean.html#getTotalCapacity--).

<!-- semconv metric.jvm.buffer.limit(metric_table) -->
<!-- semconv metric.jvm.buffer.memory.limit(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `jvm.buffer.limit` | UpDownCounter | `By` | Measure of total memory capacity of buffers. |
| `jvm.buffer.memory.limit` | UpDownCounter | `By` | Measure of total memory capacity of buffers. |
<!-- endsemconv -->

<!-- semconv metric.jvm.buffer.limit(full) -->
<!-- semconv metric.jvm.buffer.memory.limit(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | Recommended |
8 changes: 4 additions & 4 deletions model/metrics/process-runtime-jvm-metrics-experimental.yaml
Original file line number Diff line number Diff line change
@@ -45,17 +45,17 @@ groups:
Pool names are generally obtained via
[BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()).
- id: metric.jvm.buffer.usage
- id: metric.jvm.buffer.memory.usage
type: metric
metric_name: jvm.buffer.usage
metric_name: jvm.buffer.memory.usage
extends: attributes.jvm.buffer
brief: "Measure of memory used by buffers."
instrument: updowncounter
unit: "By"

- id: metric.jvm.buffer.limit
- id: metric.jvm.buffer.memory.limit
type: metric
metric_name: jvm.buffer.limit
metric_name: jvm.buffer.memory.limit
extends: attributes.jvm.buffer
brief: "Measure of total memory capacity of buffers."
instrument: updowncounter
6 changes: 4 additions & 2 deletions schema-next.yaml
Original file line number Diff line number Diff line change
@@ -24,8 +24,10 @@ versions:
process.runtime.jvm.memory.init: jvm.memory.init
process.runtime.jvm.system.cpu.utilization: jvm.system.cpu.utilization
process.runtime.jvm.system.cpu.load_1m: jvm.system.cpu.load_1m
process.runtime.jvm.buffer.usage: jvm.buffer.usage
process.runtime.jvm.buffer.limit: jvm.buffer.limit
# https://github.com/open-telemetry/semantic-conventions/pull/999
process.runtime.jvm.buffer.usage: jvm.buffer.memory.usage
# https://github.com/open-telemetry/semantic-conventions/pull/999
process.runtime.jvm.buffer.limit: jvm.buffer.memory.limit
process.runtime.jvm.buffer.count: jvm.buffer.count
# https://github.com/open-telemetry/semantic-conventions/pull/20
- rename_attributes:

0 comments on commit e5f31e2

Please sign in to comment.