diff --git a/.chloggen/jvm_memory-buffer_metric_renaming.yaml b/.chloggen/jvm_memory-buffer_metric_renaming.yaml new file mode 100755 index 0000000000..72ca3e2f00 --- /dev/null +++ b/.chloggen/jvm_memory-buffer_metric_renaming.yaml @@ -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: jvm + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: "Rename JVM metric `jvm.buffer.memory.usage` to `jvm.buffer.memory.used`" + +# 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: [288, 1265] + +# (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: diff --git a/docs/runtime/jvm-metrics.md b/docs/runtime/jvm-metrics.md index 33bfa93f4c..cbda57ad10 100644 --- a/docs/runtime/jvm-metrics.md +++ b/docs/runtime/jvm-metrics.md @@ -33,7 +33,7 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry. - [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.memory.usage`](#metric-jvmbuffermemoryusage) + - [Metric: `jvm.buffer.memory.used`](#metric-jvmbuffermemoryused) - [Metric: `jvm.buffer.memory.limit`](#metric-jvmbuffermemorylimit) - [Metric: `jvm.buffer.count`](#metric-jvmbuffercount) @@ -743,12 +743,12 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht -### Metric: `jvm.buffer.memory.usage` +### Metric: `jvm.buffer.memory.used` 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--). - + @@ -757,7 +757,7 @@ This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.o | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `jvm.buffer.memory.usage` | UpDownCounter | `By` | Measure of memory used by buffers. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `jvm.buffer.memory.used` | UpDownCounter | `By` | Measure of memory used by buffers. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -765,7 +765,7 @@ This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.o - + diff --git a/model/metrics/jvm-metrics-experimental.yaml b/model/metrics/jvm-metrics-experimental.yaml index 6cb5f6fb2c..33b7a89c4b 100644 --- a/model/metrics/jvm-metrics-experimental.yaml +++ b/model/metrics/jvm-metrics-experimental.yaml @@ -42,9 +42,9 @@ groups: - ref: jvm.buffer.pool.name requirement_level: recommended - - id: metric.jvm.buffer.memory.usage + - id: metric.jvm.buffer.memory.used type: metric - metric_name: jvm.buffer.memory.usage + metric_name: jvm.buffer.memory.used stability: experimental extends: attributes.jvm.buffer brief: "Measure of memory used by buffers." diff --git a/schema-next.yaml b/schema-next.yaml index bb6c64e824..f475f28047 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -70,6 +70,9 @@ versions: - process.cpu.time - process.cpu.utilization - container.cpu.time + # https://github.com/open-telemetry/semantic-conventions/pull/1265 + - rename_metrics: + jvm.buffer.memory.usage: jvm.buffer.memory.used 1.26.0: metrics: changes: