From e5f31e2c1470acb5ff88aa752a6141bf240252d7 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 14 Aug 2023 14:25:39 -0700 Subject: [PATCH] Rename jvm.buffer.(usage|limit) to jvm.buffer.memory.(usage|limit) --- CHANGELOG.md | 3 +++ docs/system/runtime-environment-metrics.md | 20 +++++++++---------- ...cess-runtime-jvm-metrics-experimental.yaml | 8 ++++---- schema-next.yaml | 6 ++++-- 4 files changed, 21 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c8c5f52301..2ce4c58c7a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/docs/system/runtime-environment-metrics.md b/docs/system/runtime-environment-metrics.md index c0843daf01..e634b37d71 100644 --- a/docs/system/runtime-environment-metrics.md +++ b/docs/system/runtime-environment-metrics.md @@ -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) @@ -371,18 +371,18 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht -### 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--). - + | 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. | - + | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | Recommended | @@ -390,18 +390,18 @@ This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.o **[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()). -### 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--). - + | 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. | - + | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `jvm.buffer.pool.name` | string | Name of the buffer pool. [1] | `mapped`; `direct` | Recommended | diff --git a/model/metrics/process-runtime-jvm-metrics-experimental.yaml b/model/metrics/process-runtime-jvm-metrics-experimental.yaml index da74d34423..8ea4fa57c5 100644 --- a/model/metrics/process-runtime-jvm-metrics-experimental.yaml +++ b/model/metrics/process-runtime-jvm-metrics-experimental.yaml @@ -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 diff --git a/schema-next.yaml b/schema-next.yaml index e19ff8a65e..fea4f474e1 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -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: