Rename metric jvm.buffer.memory.usage to jvm.buffer.memory.used (#1265)

Signed-off-by: Lenin Jaganathan<lenin.jaganathan@gmail.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>

Author: 3 people

.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]
+
+# (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:

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
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### 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--).
 
-<!-- semconv metric.jvm.buffer.memory.usage(metric_table) -->
+<!-- semconv metric.jvm.buffer.memory.used(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -757,15 +757,15 @@ 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) |
 
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.jvm.buffer.memory.usage(full) -->
+<!-- semconv metric.jvm.buffer.memory.used(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->

model/metrics/deprecated/jvm-metrics.yaml

@@ -0,0 +1,10 @@
+groups:
+  - id: metric.jvm.buffer.memory.usage.deprecated
+    type: metric
+    metric_name: jvm.buffer.memory.usage
+    stability: experimental
+    deprecated: "Replaced by `jvm.buffer.memory.used`."
+    brief: "Deprecated, use `jvm.buffer.memory.used` instead."
+    extends: attributes.jvm.buffer
+    instrument: updowncounter
+    unit: "By"

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."

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: