Rename jvm.buffer.(usage|limit) to jvm.buffer.memory.(usage|limit) (#253

)

Co-authored-by: Armin Ruech <[email protected]>

CHANGELOG.md

@@ -50,6 +50,9 @@ release.
   ([#249](https://github.com/open-telemetry/semantic-conventions/pull/249))
 - Add `jvm.cpu.count` metric.
   ([#52](https://github.com/open-telemetry/semantic-conventions/pull/52))
+- BREAKING: Rename metrics `jvm.buffer.usage` to `jvm.buffer.memory.usage`
+  and `jvm.buffer.limit` to `jvm.buffer.memory.limit`.
+  ([#253](https://github.com/open-telemetry/semantic-conventions/pull/253))
 - BREAKING: Rename `jvm.classes.current_loaded` metrics to `jvm.classes.count`
   ([#60](https://github.com/open-telemetry/semantic-conventions/pull/60))
 

docs/system/runtime-environment-metrics.md

@@ -36,8 +36,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 -->
@@ -387,37 +387,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 |

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

schema-next.yaml

@@ -25,8 +25,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/253
+            process.runtime.jvm.buffer.usage: jvm.buffer.memory.usage
+            # https://github.com/open-telemetry/semantic-conventions/pull/253
+            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: