open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename metrics `jvm.memory.usage` to `jvm.memory.used` and `jvm.memory.usage_after_last_gc` to `jvm.memory.used_after_last_gc` (#536) 

Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
This commit is contained in:
Trask Stalnaker 2023-11-20 07:45:22 -08:00 committed by GitHub
parent dccfffc9bf
commit 126059d99d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -15,6 +15,9 @@ release.
([#495](https://github.com/open-telemetry/semantic-conventions/issues/495))
- Changed `messaging.system` attribute type to an open enum
([#517](https://github.com/open-telemetry/semantic-conventions/pull/517))
- Rename metrics `jvm.memory.usage` to `jvm.memory.used` and `jvm.memory.usage_after_last_gc`
to `jvm.memory.used_after_last_gc`
([#536](https://github.com/open-telemetry/semantic-conventions/pull/536))
### Features

20
docs/runtime/jvm-metrics.md
View File

@ -13,10 +13,10 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry.
<!-- toc -->
- [JVM Memory](#jvm-memory)
* [Metric: `jvm.memory.usage`](#metric-jvmmemoryusage)
* [Metric: `jvm.memory.used`](#metric-jvmmemoryused)
* [Metric: `jvm.memory.committed`](#metric-jvmmemorycommitted)
* [Metric: `jvm.memory.limit`](#metric-jvmmemorylimit)
* [Metric: `jvm.memory.usage_after_last_gc`](#metric-jvmmemoryusage_after_last_gc)
* [Metric: `jvm.memory.used_after_last_gc`](#metric-jvmmemoryused_after_last_gc)
- [JVM Garbage Collection](#jvm-garbage-collection)
* [Metric: `jvm.gc.duration`](#metric-jvmgcduration)
- [JVM Threads](#jvm-threads)
@ -43,18 +43,18 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry.
**Description:** Java Virtual Machine (JVM) metrics captured under the namespace `jvm.memory.*`
### Metric: `jvm.memory.usage`
### Metric: `jvm.memory.used`
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getUsage--).
<!-- semconv metric.jvm.memory.usage(metric_table) -->
<!-- semconv metric.jvm.memory.used(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `jvm.memory.usage` | UpDownCounter | `By` | Measure of memory used. |
| `jvm.memory.used` | UpDownCounter | `By` | Measure of memory used. |
<!-- endsemconv -->
<!-- semconv metric.jvm.memory.usage(full) -->
<!-- semconv metric.jvm.memory.used(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `jvm.memory.pool.name` | string | Name of the memory pool. [1] | `G1 Old Gen`; `G1 Eden space`; `G1 Survivor Space` | Recommended |
@ -124,18 +124,18 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle
| `non_heap` | Non-heap memory |
<!-- endsemconv -->
### Metric: `jvm.memory.usage_after_last_gc`
### Metric: `jvm.memory.used_after_last_gc`
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getCollectionUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getCollectionUsage--).
<!-- semconv metric.jvm.memory.usage_after_last_gc(metric_table) -->
<!-- semconv metric.jvm.memory.used_after_last_gc(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `jvm.memory.usage_after_last_gc` | UpDownCounter | `By` | Measure of memory used, as measured after the most recent garbage collection event on this pool. |
| `jvm.memory.used_after_last_gc` | UpDownCounter | `By` | Measure of memory used, as measured after the most recent garbage collection event on this pool. |
<!-- endsemconv -->
<!-- semconv metric.jvm.memory.usage_after_last_gc(full) -->
<!-- semconv metric.jvm.memory.used_after_last_gc(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `jvm.memory.pool.name` | string | Name of the memory pool. [1] | `G1 Old Gen`; `G1 Eden space`; `G1 Survivor Space` | Recommended |

8
model/metrics/jvm-metrics.yaml
View File

@ -26,9 +26,9 @@ groups:
Pool names are generally obtained via
[MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()).
- id: metric.jvm.memory.usage
- id: metric.jvm.memory.used
type: metric
metric_name: jvm.memory.usage
metric_name: jvm.memory.used
extends: attributes.jvm.memory
brief: "Measure of memory used."
instrument: updowncounter
@ -50,9 +50,9 @@ groups:
instrument: updowncounter
unit: "By"
- id: metric.jvm.memory.usage_after_last_gc
- id: metric.jvm.memory.used_after_last_gc
type: metric
metric_name: jvm.memory.usage_after_last_gc
metric_name: jvm.memory.used_after_last_gc
extends: attributes.jvm.memory
brief: "Measure of memory used, as measured after the most recent garbage collection event on this pool."
instrument: updowncounter

4
schema-next.yaml
View File

@ -2,6 +2,10 @@ file_format: 1.1.0
schema_url: https://opentelemetry.io/schemas/next
versions:
next:
# https://github.com/open-telemetry/semantic-conventions/pull/536
- rename_metrics:
jvm.memory.usage: jvm.memory.used
jvm.memory.usage_after_last_gc: jvm.memory.used_after_last_gc
1.23.0:
metrics:
changes: