Skip to content

Commit

Permalink
Add additional process metrics to the metrics semantic conventions
Browse files Browse the repository at this point in the history 
Add the following:
- `process.voluntary_context_switches`
- `process.involuntary_context_switches`
- `process.open_file_descriptors`
  • Loading branch information
@evan-bradley
evan-bradley committed Aug 8, 2022
1 parent 1d11c58 commit a9cc1f7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ release.
([#2619](https://github.com/open-telemetry/opentelemetry-specification/pull/2619)).
- Clarify async instrument callback identity.
([#2538](https://github.com/open-telemetry/opentelemetry-specification/pull/2538)).
- Add `process.voluntary_context_switches`, `process.involuntary_context_switches`,
and `process.open_file_descriptors`, to the metrics semantic conventions
([#2706](https://github.com/open-telemetry/opentelemetry-specification/pull/2706)).

### Logs

Expand Down
27 changes: 15 additions & 12 deletions specification/metrics/semantic_conventions/process-metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,21 @@ 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 | s | 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` (deprecated) | Counter | By | Disk bytes transferred. | `direction` SHOULD be one of: `read`, `write` |
| `process.disk.io.read` | Counter | By | Disk bytes read. | |
| `process.disk.io.write` | Counter | By | Disk bytes written. | |
| `process.network.io` (deprecated) | Counter | By | Network bytes transferred. | `direction` SHOULD be one of: `receive`, `transmit` |
| `process.network.io.receive` | Counter | By | Network bytes received. | |
| `process.network.io.transmit` | Counter | By | Network bytes transmitted. | |
| Name | Instrument Type ([\*](README.md#instrument-types)) | Unit ([UCUM](README.md#instrument-units)) | 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 | s | 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` (deprecated) | Counter | By | Disk bytes transferred. | `direction` SHOULD be one of: `read`, `write` |
| `process.disk.io.read` | Counter | By | Disk bytes read. | |
| `process.disk.io.write` | Counter | By | Disk bytes written. | |
| `process.network.io` (deprecated) | Counter | By | Network bytes transferred. | `direction` SHOULD be one of: `receive`, `transmit` |
| `process.network.io.receive` | Counter | By | Network bytes received. | |
| `process.network.io.transmit` | Counter | By | Network bytes transmitted. | |
| `process.open_file_descriptors` | UpDownCounter | {count} | Number of file descriptors in use by the process. |
| `process.context_switches.voluntary` | Counter | {count} | Number of times the process has been voluntarily context switched. |
| `process.context_switches.involuntary` | Counter | {count} | Number of times the process has been involuntarily context switched. |

## Attributes

Expand Down

0 comments on commit a9cc1f7

Please sign in to comment.