From f9e4ef83f41490ac3f8b65b987cbb32b90a7dbb4 Mon Sep 17 00:00:00 2001 From: braydonk Date: Thu, 20 Nov 2025 15:22:00 +0000 Subject: [PATCH 1/3] set requirement levels --- model/process/metrics.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/model/process/metrics.yaml b/model/process/metrics.yaml index ff9b6b041a..219fba011a 100644 --- a/model/process/metrics.yaml +++ b/model/process/metrics.yaml @@ -2,6 +2,7 @@ groups: - id: metric.process.cpu.time type: metric metric_name: process.cpu.time + requirement_level: recommended annotations: code_generation: metric_value_type: double @@ -11,6 +12,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. @@ -21,6 +23,7 @@ groups: - id: metric.process.cpu.utilization type: metric metric_name: process.cpu.utilization + requirement_level: opt_in annotations: code_generation: metric_value_type: double @@ -32,6 +35,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. @@ -42,6 +46,7 @@ groups: - id: metric.process.memory.usage type: metric metric_name: process.memory.usage + requirement_level: required annotations: code_generation: metric_value_type: int @@ -56,6 +61,7 @@ groups: - id: metric.process.memory.virtual type: metric metric_name: process.memory.virtual + requirement_level: opt_in annotations: code_generation: metric_value_type: int @@ -70,6 +76,7 @@ groups: - id: metric.process.disk.io type: metric metric_name: process.disk.io + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -79,12 +86,14 @@ groups: unit: "By" attributes: - ref: disk.io.direction + requirement_level: required entity_associations: - process - id: metric.process.network.io type: metric metric_name: process.network.io + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -94,12 +103,14 @@ groups: unit: "By" attributes: - ref: network.io.direction + requirement_level: required entity_associations: - process - id: metric.process.thread.count type: metric metric_name: process.thread.count + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -113,6 +124,7 @@ groups: - id: metric.process.open_file_descriptor.count type: metric metric_name: process.open_file_descriptor.count + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -126,6 +138,7 @@ groups: - id: metric.process.context_switches type: metric metric_name: process.context_switches + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -135,12 +148,14 @@ groups: unit: "{context_switch}" attributes: - ref: process.context_switch.type + requirement_level: required entity_associations: - process - id: metric.process.paging.faults type: metric metric_name: process.paging.faults + requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -150,12 +165,14 @@ groups: unit: "{fault}" attributes: - ref: system.paging.fault.type + requirement_level: recommended entity_associations: - process - id: metric.process.uptime type: metric metric_name: process.uptime + requirement_level: opt_in annotations: code_generation: metric_value_type: double From 8d917ca9cbd4490b353c210ff758958dfaa77906 Mon Sep 17 00:00:00 2001 From: braydonk Date: Thu, 20 Nov 2025 15:46:21 +0000 Subject: [PATCH 2/3] generate markdown --- docs/system/process-metrics.md | 10 +++++----- model/process/metrics.yaml | 11 ----------- 2 files changed, 5 insertions(+), 16 deletions(-) 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 219fba011a..04c94c2c7b 100644 --- a/model/process/metrics.yaml +++ b/model/process/metrics.yaml @@ -2,7 +2,6 @@ groups: - id: metric.process.cpu.time type: metric metric_name: process.cpu.time - requirement_level: recommended annotations: code_generation: metric_value_type: double @@ -23,7 +22,6 @@ groups: - id: metric.process.cpu.utilization type: metric metric_name: process.cpu.utilization - requirement_level: opt_in annotations: code_generation: metric_value_type: double @@ -46,7 +44,6 @@ groups: - id: metric.process.memory.usage type: metric metric_name: process.memory.usage - requirement_level: required annotations: code_generation: metric_value_type: int @@ -61,7 +58,6 @@ groups: - id: metric.process.memory.virtual type: metric metric_name: process.memory.virtual - requirement_level: opt_in annotations: code_generation: metric_value_type: int @@ -76,7 +72,6 @@ groups: - id: metric.process.disk.io type: metric metric_name: process.disk.io - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -93,7 +88,6 @@ groups: - id: metric.process.network.io type: metric metric_name: process.network.io - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -110,7 +104,6 @@ groups: - id: metric.process.thread.count type: metric metric_name: process.thread.count - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -124,7 +117,6 @@ groups: - id: metric.process.open_file_descriptor.count type: metric metric_name: process.open_file_descriptor.count - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -138,7 +130,6 @@ groups: - id: metric.process.context_switches type: metric metric_name: process.context_switches - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -155,7 +146,6 @@ groups: - id: metric.process.paging.faults type: metric metric_name: process.paging.faults - requirement_level: recommended annotations: code_generation: metric_value_type: int @@ -172,7 +162,6 @@ groups: - id: metric.process.uptime type: metric metric_name: process.uptime - requirement_level: opt_in annotations: code_generation: metric_value_type: double From 8eeb3ec639b19fe21ac04a65f66dd2f5c11ba668 Mon Sep 17 00:00:00 2001 From: braydonk Date: Fri, 21 Nov 2025 19:57:31 +0000 Subject: [PATCH 3/3] add changelog entry --- .chloggen/process_req_levels.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .chloggen/process_req_levels.yaml 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: