Skip to content

[process] Promote process metrics to RC #3757

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

Closed
osullivandonal wants to merge 1 commit into from
+46 −24
Closed

[process] Promote process metrics to RC #3757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions .chloggen/update-process-metrics-to-RC.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: process

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Promote process metrics to release_candidate

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [3041]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
24 changes: 12 additions & 12 deletions docs/system/process-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.cpu.time` | Counter | `s` | Total CPU seconds broken down by different CPU modes. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.cpu.time` | Counter | `s` | Total CPU seconds broken down by different CPU modes. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -96,7 +96,7 @@ This metric is [opt-in][MetricOptIn].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `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. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `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. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -135,7 +135,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.memory.usage` | UpDownCounter | `By` | The amount of physical memory in use. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.memory.usage` | UpDownCounter | `By` | The amount of physical memory in use. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand All @@ -152,7 +152,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.memory.virtual` | UpDownCounter | `By` | The amount of committed virtual memory. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.memory.virtual` | UpDownCounter | `By` | The amount of committed virtual memory. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand All @@ -169,7 +169,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.disk.io` | Counter | `By` | Disk bytes transferred. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.disk.io` | Counter | `By` | Disk bytes transferred. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -201,7 +201,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.network.io` | Counter | `By` | Network bytes transferred. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.network.io` | Counter | `By` | Network bytes transferred. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -233,7 +233,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.thread.count` | UpDownCounter | `{thread}` | Process threads count. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.thread.count` | UpDownCounter | `{thread}` | Process threads count. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand All @@ -250,7 +250,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.unix.file_descriptor.count` | UpDownCounter | `{file_descriptor}` | Number of unix file descriptors in use by the process. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.unix.file_descriptor.count` | UpDownCounter | `{file_descriptor}` | Number of unix file descriptors in use by the process. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand All @@ -267,7 +267,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.windows.handle.count` | UpDownCounter | `{handle}` | Number of handles held by the process. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.windows.handle.count` | UpDownCounter | `{handle}` | Number of handles held by the process. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
Expand All @@ -284,7 +284,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.context_switches` | Counter | `{context_switch}` | Number of times the process has been context switched. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.context_switches` | Counter | `{context_switch}` | Number of times the process has been context switched. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -316,7 +316,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.paging.faults` | Counter | `{fault}` | Number of page faults the process has made. | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.paging.faults` | Counter | `{fault}` | Number of page faults the process has made. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**Attributes:**

Expand Down Expand Up @@ -348,7 +348,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `process.uptime` | Gauge | `s` | The time the process has been running. [1] | ![Development](https://img.shields.io/badge/-development-blue) | [`process`](/docs/registry/entities/process.md#process) |
| `process.uptime` | Gauge | `s` | The time the process has been running. [1] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | [`process`](/docs/registry/entities/process.md#process) |

**[1]:** Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available.
The actual accuracy would depend on the instrumentation and operating system.
Expand Down
24 changes: 12 additions & 12 deletions model/process/metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ groups:
annotations:
code_generation:
metric_value_type: double
stability: development
stability: release_candidate
brief: "Total CPU seconds broken down by different CPU modes."
instrument: counter
unit: "s"
Expand All @@ -27,7 +27,7 @@ groups:
annotations:
code_generation:
metric_value_type: double
stability: development
stability: release_candidate
brief:
Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs
available to the process.
Expand All @@ -51,7 +51,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "The amount of physical memory in use."
instrument: updowncounter
unit: "By"
Expand All @@ -65,7 +65,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "The amount of committed virtual memory."
instrument: updowncounter
unit: "By"
Expand All @@ -79,7 +79,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Disk bytes transferred."
instrument: counter
unit: "By"
Expand All @@ -95,7 +95,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Network bytes transferred."
instrument: counter
unit: "By"
Expand All @@ -111,7 +111,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Process threads count."
instrument: updowncounter
unit: "{thread}"
Expand All @@ -124,7 +124,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Number of unix file descriptors in use by the process."
instrument: updowncounter
unit: "{file_descriptor}"
Expand All @@ -137,7 +137,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Number of handles held by the process."
instrument: updowncounter
unit: "{handle}"
Expand All @@ -150,7 +150,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Number of times the process has been context switched."
instrument: counter
unit: "{context_switch}"
Expand All @@ -166,7 +166,7 @@ groups:
annotations:
code_generation:
metric_value_type: int
stability: development
stability: release_candidate
brief: "Number of page faults the process has made."
instrument: counter
unit: "{fault}"
Expand All @@ -186,7 +186,7 @@ groups:
annotations:
code_generation:
metric_value_type: double
stability: development
stability: release_candidate
brief: "The time the process has been running."
note: |
Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available.
Expand Down
Loading