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.

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 process.runtime.jvm.cpu.utilization to process.runtime.jvm.cpu.recent_utilization #53

Merged
merged 4 commits into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ release.
([#3458](https://github.com/open-telemetry/opentelemetry-specification/pull/3458))
- Specify the value range for JVM CPU metrics.
([#13](https://github.com/open-telemetry/semantic-conventions/pull/13))
- Rename `process.runtime.jvm.cpu.utilization` to `process.runtime.jvm.cpu.recent_utilization`.
([#53](https://github.com/open-telemetry/semantic-conventions/pull/53))
- Clarify `process.runtime.jvm.threads.count` refers to platform threads.
([#54](https://github.com/open-telemetry/semantic-conventions/pull/54))
- Add `gcp.gce.instance.name` and `gcp.gce.instance.hostname` resource
Expand Down
7 changes: 6 additions & 1 deletion schemas/1.21.0
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@ versions:
http.scheme: url.scheme
http.url: url.full
http.request_content_length: http.request.body.size
http.response_content_length: http.response.body.size
http.response_content_length: http.response.body.size
metrics:
changes:
# https://github.com/open-telemetry/semantic-conventions/pull/53
- rename_metrics:
process.runtime.jvm.cpu.utilization: process.runtime.jvm.cpu.recent_utilization
1.20.0:
spans:
changes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ 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: >
The value range is [0.0,1.0].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ 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.cpu.recent_utilization`](#metric-processruntimejvmcpurecent_utilization)
* [Metric: `process.runtime.jvm.system.cpu.utilization`](#metric-processruntimejvmsystemcpuutilization)
* [Metric: `process.runtime.jvm.system.cpu.load_1m`](#metric-processruntimejvmsystemcpuload_1m)
* [Metric: `process.runtime.jvm.buffer.usage`](#metric-processruntimejvmbufferusage)
Expand Down Expand Up @@ -298,19 +298,20 @@ This metric is obtained from [`ClassLoadingMXBean#getLoadedClassCount()`](https:
<!-- 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][MetricRecommended].
This metric is obtained from [`com.sun.management.OperatingSystemMXBean#getProcessCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()) on HotSpot
and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuLoad()`](https://www.ibm.com/docs/api/v1/content/SSYKE2_8.0.0/openj9/api/jdk8/jre/management/extension/com/ibm/lang/management/OperatingSystemMXBean.html#getProcessCpuLoad--) on J9.
Note that the JVM does not provide a definition of what "recent" means.

<!-- 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`
Expand Down