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

Jump to bottom

Add namespace for process metric attributes #3431

Closed
wants to merge 9 commits into from
Closed

Add namespace for process metric attributes #3431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4bfeeb3
Add namespace for process metric attributes
trask Apr 21, 2023
7d71cbd
Change log entry
trask Apr 21, 2023
62088b0
cpu.context_switch -> os.context_switch
trask Apr 21, 2023
6aa922c
os.context_switch -> context_switch
trask Apr 21, 2023
975400c
Merge branch 'main' into process-metric-attrs
trask Apr 25, 2023
f2a4769
Add schema transformation
trask Apr 25, 2023
4d04e08
Merge branch 'main' into process-metric-attrs
reyang May 1, 2023
4312df7
Merge remote-tracking branch 'upstream/main' into process-metric-attrs
trask May 8, 2023
1c195d6
Fix
trask May 8, 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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ release.
- Add transition plan for upcoming breaking changes to the unstable HTTP semantic
conventions.
([#3443](https://github.com/open-telemetry/opentelemetry-specification/pull/3443))
- Rename `process.cpu.time` metric attribute `state` to `cpu.state`,
rename `process.cpu.utilization` metric attribute `state` to `cpu.state`,
rename `process.disk.io` metric attribute `direction` to `disk.direction`,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not targeting this PR, I'll restate that disk direction is very weird, most operating systems model disks with read/write/control.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand wanting the consistency. I, personally, view disk as "yet another type of network operation", thanks to years of SAN and DFS.

I think we SHOULD get together a semconv group to really look at these at some point, but unfortunately we have a ton of users right now.

Simple renames and namespacing, I think we can afford to do, especially given what this could provide us w/ Log -> Metric or Trace -> Metric generation.

Anything more semantically different, we need to be cautious about.

rename `process.network.io` metric attribute `direction` to `network.direction`,
rename `process.context_switches` metric attribute `type` to `context_switch.type`,
rename `process.paging.faults` metric attribute `type` to `memory.page_fault.type`,
([#3431](https://github.com/open-telemetry/opentelemetry-specification/pull/3431))

### Compatibility

Expand Down
29 changes: 29 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,35 @@ 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/3431
- rename_attributes:
attribute_map:
state: cpu.state
apply_to_metrics:
- process.cpu.time
- process.cpu.utilization
- rename_attributes:
attribute_map:
direction: disk.direction
apply_to_metrics:
- process.disk.io
- rename_attributes:
attribute_map:
direction: network.direction
apply_to_metrics:
- process.network.io
- rename_attributes:
attribute_map:
type: context_switch.type
apply_to_metrics:
- process.context_switches
- rename_attributes:
attribute_map:
type: memory.page_fault.type
apply_to_metrics:
- process.paging.faults
1.20.0:
spans:
changes:
Expand Down
24 changes: 12 additions & 12 deletions specification/metrics/semantic_conventions/process-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ metrics](runtime-environment-metrics.md).

Below is a table of Process metric instruments.

| Name | Instrument Type ([\*](README.md#instrument-types)) | Unit | Description | Labels |
|---------------------------------|----------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `process.cpu.time` | Counter | s | Total CPU seconds broken down by different states. | `state`, if specified, SHOULD be one of: `system`, `user`, `wait`. A process SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. |
| `process.cpu.utilization` | Gauge | 1 | Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process. | `state`, if specified, SHOULD be one of: `system`, `user`, `wait`. A process SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. |
| `process.memory.usage` | UpDownCounter | By | The amount of physical memory in use. | |
| `process.memory.virtual` | UpDownCounter | By | The amount of committed virtual memory. | |
| `process.disk.io` | Counter | By | Disk bytes transferred. | `direction` SHOULD be one of: `read`, `write` |
| `process.network.io` | Counter | By | Network bytes transferred. | `direction` SHOULD be one of: `receive`, `transmit` |
| `process.threads` | UpDownCounter | {thread} | Process threads count. | |
| `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | |
| `process.context_switches` | Counter | {count} | Number of times the process has been context switched. | `type` SHOULD be one of: `involuntary`, `voluntary` |
| `process.paging.faults` | Counter | {fault} | Number of page faults the process has made. | `type`, if specified, SHOULD be one of: `major` (for major, or hard, page faults), `minor` (for minor, or soft, page faults). |
| Name | Instrument Type ([\*](README.md#instrument-types)) | Unit | Description | Labels |
|---------------------------------|----------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `process.cpu.time` | Counter | s | Total CPU seconds broken down by different states. | `cpu.state`, if specified, SHOULD be one of: `system`, `user`, `wait`. A process SHOULD be characterized _either_ by data points with no `cpu.state` labels, _or only_ data points with `cpu.state` labels. |
| `process.cpu.utilization` | Gauge | 1 | Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process. | `cpu.state`, if specified, SHOULD be one of: `system`, `user`, `wait`. A process SHOULD be characterized _either_ by data points with no `cpu.state` labels, _or only_ data points with `cpu.state` labels. |
| `process.memory.usage` | UpDownCounter | By | The amount of physical memory in use. | |
| `process.memory.virtual` | UpDownCounter | By | The amount of committed virtual memory. | |
| `process.disk.io` | Counter | By | Disk bytes transferred. | `disk.direction` SHOULD be one of: `read`, `write` |
| `process.network.io` | Counter | By | Network bytes transferred. | `network.direction` SHOULD be one of: `receive`, `transmit` |
| `process.threads` | UpDownCounter | {thread} | Process threads count. | |
| `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. | |
| `process.context_switches` | Counter | {count} | Number of times the process has been context switched. | `context_switch.type` SHOULD be one of: `involuntary`, `voluntary` |
| `process.paging.faults` | Counter | {fault} | Number of page faults the process has made. | `memory.page_fault.type`, if specified, SHOULD be one of: `major` (for major, or hard, page faults), `minor` (for minor, or soft, page faults). |

## Attributes

Expand Down