tune cpu.mode for other metric

Signed-off-by: ChrsMark <[email protected]>
open-telemetry · Jul 29, 2024 · d968090 · d968090
1 parent be6f6b6
commit d968090
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/docs/system/container-metrics.md b/docs/system/container-metrics.md
@@ -46,10 +46,12 @@ This metric is [opt-in][MetricOptIn].
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`cpu.mode`](/docs/attributes-registry/cpu.md) | string | The CPU mode for this data point. A container's CPU metric SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`cpu.mode`](/docs/attributes-registry/cpu.md) | string | The CPU mode for this data point. A container's CPU metric SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | `Conditionally Required` [2] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1]:** Following states SHOULD be used: `user`, `system`, `kernel`
 
+**[2]:** Required if mode is available, i.e. metrics coming from the Docker Stats API.
+
 
 
 `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
@@ -106,10 +108,12 @@ This metric is [opt-in][MetricOptIn].
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
-| [`cpu.mode`](/docs/attributes-registry/cpu.md) | string | The CPU mode for this data point. A container's CPU metric SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`cpu.mode`](/docs/attributes-registry/cpu.md) | string | The CPU mode for this data point. A container's CPU metric SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels. [1] | `user`; `system` | `Conditionally Required` [2] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1]:** Following states SHOULD be used: `user`, `system`, `kernel`
 
+**[2]:** Required if mode is available, i.e. metrics coming from the Docker Stats API.
+
 
 
 `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

diff --git a/model/metrics/container.yaml b/model/metrics/container.yaml
@@ -13,7 +13,8 @@ groups:
       - ref: cpu.mode
         brief: "The CPU mode for this data point. A container's CPU metric SHOULD be characterized _either_ by data points with no `mode` labels, _or only_ data points with `mode` labels."
         note: "Following states SHOULD be used: `user`, `system`, `kernel`"
-        requirement_level: opt_in
+        requirement_level:
+          conditionally_required: Required if mode is available, i.e. metrics coming from the Docker Stats API.
 
   - id: metric.container.cpu.usage
     type: metric