Add brief note for the states

Signed-off-by: ChrsMark <[email protected]>
ChrsMark · Feb 1, 2024 · 23a5752 · 23a5752
1 parent 7fa701b
commit 23a5752
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/system/container-metrics.md b/docs/system/container-metrics.md
@@ -30,9 +30,9 @@ This metric is optional.
 
 | Value  | Description |
 |---|---|
-| `user` | user |
-| `system` | system |
-| `kernel` | kernel |
+| `user` | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). |
+| `system` | When CPU is used by the system |
+| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). |
 <!-- endsemconv -->
 
 ### Metric: `container.memory.utilization`

diff --git a/model/metrics/container.yaml b/model/metrics/container.yaml
@@ -11,10 +11,13 @@ groups:
           members:
             - id: user
               value: 'user'
+              brief: "When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows)."
             - id: system
               value: 'system'
+              brief: "When CPU is used by the system"
             - id: kernel
               value: 'kernel'
+              brief: "When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows)."
         brief: "The state of the CPU"
         examples: ["user", "kernel"]
   - id: metric.container.cpu.time