diff --git a/.chloggen/process_req_levels.yaml b/.chloggen/process_req_levels.yaml new file mode 100644 index 0000000000..5f7407a6af --- /dev/null +++ b/.chloggen/process_req_levels.yaml @@ -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: Added specific requirement levels to all attribute refs within process metrics. + +# 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: [864] + +# (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: diff --git a/docs/system/process-metrics.md b/docs/system/process-metrics.md index 3f0bdfa5cd..cd027055cd 100644 --- a/docs/system/process-metrics.md +++ b/docs/system/process-metrics.md @@ -63,7 +63,7 @@ This metric is [recommended][MetricRecommended]. | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -| [`cpu.mode`](/docs/registry/attributes/cpu.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | +| [`cpu.mode`](/docs/registry/attributes/cpu.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | **[1] `cpu.mode`:** Following states SHOULD be used: `user`, `system`, `wait` @@ -106,7 +106,7 @@ This metric is [opt-in][MetricOptIn]. | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -| [`cpu.mode`](/docs/registry/attributes/cpu.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | +| [`cpu.mode`](/docs/registry/attributes/cpu.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | **[1] `cpu.mode`:** Following states SHOULD be used: `user`, `system`, `wait` @@ -189,7 +189,7 @@ This metric is [recommended][MetricRecommended]. | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -| [`disk.io.direction`](/docs/registry/attributes/disk.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The disk IO operation direction. | `read` | +| [`disk.io.direction`](/docs/registry/attributes/disk.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The disk IO operation direction. | `read` | --- @@ -224,7 +224,7 @@ This metric is [recommended][MetricRecommended]. | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -| [`network.io.direction`](/docs/registry/attributes/network.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The network IO operation direction. | `transmit` | +| [`network.io.direction`](/docs/registry/attributes/network.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The network IO operation direction. | `transmit` | --- @@ -299,7 +299,7 @@ This metric is [recommended][MetricRecommended]. | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | |---|---|---|---|---|---| -| [`process.context_switch.type`](/docs/registry/attributes/process.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | Specifies whether the context switches for this data point were voluntary or involuntary. | `voluntary`; `involuntary` | +| [`process.context_switch.type`](/docs/registry/attributes/process.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | Specifies whether the context switches for this data point were voluntary or involuntary. | `voluntary`; `involuntary` | --- diff --git a/model/process/metrics.yaml b/model/process/metrics.yaml index ff9b6b041a..04c94c2c7b 100644 --- a/model/process/metrics.yaml +++ b/model/process/metrics.yaml @@ -11,6 +11,7 @@ groups: unit: "s" attributes: - ref: cpu.mode + requirement_level: required brief: > A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. @@ -32,6 +33,7 @@ groups: unit: "1" attributes: - ref: cpu.mode + requirement_level: required brief: > A process SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. @@ -79,6 +81,7 @@ groups: unit: "By" attributes: - ref: disk.io.direction + requirement_level: required entity_associations: - process @@ -94,6 +97,7 @@ groups: unit: "By" attributes: - ref: network.io.direction + requirement_level: required entity_associations: - process @@ -135,6 +139,7 @@ groups: unit: "{context_switch}" attributes: - ref: process.context_switch.type + requirement_level: required entity_associations: - process @@ -150,6 +155,7 @@ groups: unit: "{fault}" attributes: - ref: system.paging.fault.type + requirement_level: recommended entity_associations: - process