Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename two JVM runtime metrics #3472

Closed
wants to merge 3 commits into from
Closed

Rename two JVM runtime metrics #3472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e9f890
Rename two JVM runtime metrics
trask May 5, 2023
b8e1577
Fix
trask May 5, 2023
86046cf
Fix
trask May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ release.
([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
- BREAKING: Remove `messaging.consumer.id`, make `messaging.client_id` generic
([#3336](https://github.com/open-telemetry/opentelemetry-specification/pull/3336))
- BREAKING: Rename metric `process.runtime.jvm.cpu.utilization` to
`process.runtime.jvm.cpu.recent_utilization`, and rename metric
`process.runtime.jvm.system.cpu.utilization` to
`process.runtime.jvm.system.cpu.recent_utilization`
([#3472](https://github.com/open-telemetry/opentelemetry-specification/pull/3472))

### Compatibility

Expand Down
6 changes: 6 additions & 0 deletions schemas/1.21.0
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ versions:
attribute_map:
messaging.kafka.client_id: messaging.client_id
messaging.rocketmq.client_id: messaging.client_id
metrics:
changes:
# https://github.com/open-telemetry/opentelemetry-specification/pull/3472
- rename_metrics:
process.runtime.jvm.cpu.utilization: process.runtime.jvm.cpu.recent_utilization
process.runtime.jvm.system.cpu.utilization: process.runtime.jvm.system.cpu.recent_utilization
1.20.0:
spans:
changes:
Expand Down
8 changes: 4 additions & 4 deletions semantic_conventions/metrics/process-runtime-jvm-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,19 +122,19 @@ groups:
instrument: updowncounter
unit: "{class}"

- id: metric.process.runtime.jvm.cpu.utilization
- id: metric.process.runtime.jvm.cpu.recent_utilization
type: metric
metric_name: process.runtime.jvm.cpu.utilization
metric_name: process.runtime.jvm.cpu.recent_utilization
brief: "Recent CPU utilization for the process."
note: >
This utilization is not defined as being for the specific interval since last measurement
(unlike `system.cpu.utilization`).
instrument: gauge
unit: "1"

- id: metric.process.runtime.jvm.system.cpu.utilization
- id: metric.process.runtime.jvm.system.cpu.recent_utilization
type: metric
metric_name: process.runtime.jvm.system.cpu.utilization
metric_name: process.runtime.jvm.system.cpu.recent_utilization
brief: "Recent CPU utilization for the whole system."
note: >
This utilization is not defined as being for the specific interval since last measurement
Expand Down
20 changes: 10 additions & 10 deletions specification/metrics/semantic_conventions/runtime-environment-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ semantic conventions when instrumenting runtime environments.
* [Metric: `process.runtime.jvm.classes.loaded`](#metric-processruntimejvmclassesloaded)
* [Metric: `process.runtime.jvm.classes.unloaded`](#metric-processruntimejvmclassesunloaded)
* [Metric: `process.runtime.jvm.classes.current_loaded`](#metric-processruntimejvmclassescurrent_loaded)
* [Metric: `process.runtime.jvm.cpu.utilization`](#metric-processruntimejvmcpuutilization)
* [Metric: `process.runtime.jvm.system.cpu.utilization`](#metric-processruntimejvmsystemcpuutilization)
* [Metric: `process.runtime.jvm.cpu.recent_utilization`](#metric-processruntimejvmcpurecent_utilization)
* [Metric: `process.runtime.jvm.system.cpu.recent_utilization`](#metric-processruntimejvmsystemcpurecent_utilization)
* [Metric: `process.runtime.jvm.system.cpu.load_1m`](#metric-processruntimejvmsystemcpuload_1m)
* [Metric: `process.runtime.jvm.buffer.usage`](#metric-processruntimejvmbufferusage)
* [Metric: `process.runtime.jvm.buffer.limit`](#metric-processruntimejvmbufferlimit)
Expand Down Expand Up @@ -285,30 +285,30 @@ This metric is [recommended](../metric-requirement-level.md#recommended).
<!-- semconv metric.process.runtime.jvm.classes.current_loaded(full) -->
<!-- endsemconv -->

### Metric: `process.runtime.jvm.cpu.utilization`
### Metric: `process.runtime.jvm.cpu.recent_utilization`

This metric is [recommended](../metric-requirement-level.md#recommended).

<!-- semconv metric.process.runtime.jvm.cpu.utilization(metric_table) -->
<!-- semconv metric.process.runtime.jvm.cpu.recent_utilization(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `process.runtime.jvm.cpu.utilization` | Gauge | `1` | Recent CPU utilization for the process. |
| `process.runtime.jvm.cpu.recent_utilization` | Gauge | `1` | Recent CPU utilization for the process. |
<!-- endsemconv -->

<!-- semconv metric.process.runtime.jvm.cpu.utilization(full) -->
<!-- semconv metric.process.runtime.jvm.cpu.recent_utilization(full) -->
<!-- endsemconv -->

### Metric: `process.runtime.jvm.system.cpu.utilization`
### Metric: `process.runtime.jvm.system.cpu.recent_utilization`

This metric is [recommended](../metric-requirement-level.md#recommended).

<!-- semconv metric.process.runtime.jvm.system.cpu.utilization(metric_table) -->
<!-- semconv metric.process.runtime.jvm.system.cpu.recent_utilization(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `process.runtime.jvm.system.cpu.utilization` | Gauge | `1` | Recent CPU utilization for the whole system. |
| `process.runtime.jvm.system.cpu.recent_utilization` | Gauge | `1` | Recent CPU utilization for the whole system. |
<!-- endsemconv -->

<!-- semconv metric.process.runtime.jvm.system.cpu.utilization(full) -->
<!-- semconv metric.process.runtime.jvm.system.cpu.recent_utilization(full) -->
<!-- endsemconv -->

### Metric: `process.runtime.jvm.system.cpu.load_1m`
Expand Down