deprecate *.cpu.state attributes

Signed-off-by: ChrsMark <[email protected]>
open-telemetry · May 10, 2024 · dbd49a4 · dbd49a4
1 parent 8ffe146
commit dbd49a4
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 22 deletions.
diff --git a/docs/attributes-registry/container.md b/docs/attributes-registry/container.md
diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md
@@ -62,9 +62,9 @@ An operating system process.
 
 Attributes for process CPU
 
-| Attribute           | Type   | Description                   | Examples                 | Stability                                                        |
-| ------------------- | ------ | ----------------------------- | ------------------------ | ---------------------------------------------------------------- |
-| `process.cpu.state` | string | The CPU state of the process. | `system`; `user`; `wait` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute           | Type   | Description                   | Examples                 | Stability                                                                                                                  |
+| ------------------- | ------ | ----------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
+| `process.cpu.state` | string | The CPU state of the process. | `system`; `user`; `wait` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed, report cpu state with `cpu.state` common attribute |
 
 `process.cpu.state` 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/docs/attributes-registry/system.md b/docs/attributes-registry/system.md
@@ -27,10 +27,10 @@ Describes System attributes
 
 Describes System CPU attributes
 
-| Attribute                   | Type   | Description                     | Examples                 | Stability                                                        |
-| --------------------------- | ------ | ------------------------------- | ------------------------ | ---------------------------------------------------------------- |
-| `system.cpu.logical_number` | int    | The logical CPU number [0..n-1] | `1`                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `system.cpu.state`          | string | The state of the CPU            | `user`; `system`; `nice` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                   | Type   | Description                     | Examples                 | Stability                                                                                                                  |
+| --------------------------- | ------ | ------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
+| `system.cpu.logical_number` | int    | The logical CPU number [0..n-1] | `1`                      | ![Experimental](https://img.shields.io/badge/-experimental-blue)                                                           |
+| `system.cpu.state`          | string | The state of the CPU            | `user`; `system`; `nice` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed, report cpu state with `cpu.state` common attribute |
 
 `system.cpu.state` 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/registry/container.yaml b/model/registry/container.yaml
@@ -113,4 +113,5 @@ groups:
               brief: "When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows)."
               stability: experimental
         stability: experimental
+        deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
         examples: ["user", "kernel"]
diff --git a/model/registry/cpu.yaml b/model/registry/cpu.yaml
@@ -35,4 +35,4 @@ groups:
               value: 'kernel'
               stability: experimental
         stability: experimental
-        examples: [ "user", "system" ]
+        examples: [ "user", "system" ]
diff --git a/model/registry/process.yaml b/model/registry/process.yaml
@@ -206,6 +206,7 @@ groups:
       - id: state
         brief: >
           The CPU state of the process.
+        deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
         type:
           allow_custom_values: true
           members:

diff --git a/model/registry/system.yaml b/model/registry/system.yaml
@@ -43,6 +43,7 @@ groups:
               stability: experimental
         brief: "The state of the CPU"
         stability: experimental
+        deprecated: 'Removed, report cpu state with `cpu.state` common attribute'
         examples: ["idle", "interrupt"]
       - id: logical_number
         type: int