Skip to content

Commit

Permalink
Rename metric `jvm.buffer.memory.usage
Browse files Browse the repository at this point in the history
` to `jvm.buffer.memory.used`

Signed-off-by: Lenin Jaganathan<lenin.jaganathan@gmail.com>
  • Loading branch information
lenin-jaganathan committed Jul 24, 2024
1 parent c22cd95 commit 687c4d2
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 7 deletions.
22 changes: 22 additions & 0 deletions .chloggen/jvm_memory-buffer_metric_renaming.yaml
Original file line number Diff line number Diff line change
@@ -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:
10 changes: 5 additions & 5 deletions docs/runtime/jvm-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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 -->
Expand All @@ -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 -->
Expand Down
4 changes: 2 additions & 2 deletions model/metrics/jvm-metrics-experimental.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
3 changes: 3 additions & 0 deletions schema-next.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 687c4d2

Please sign in to comment.