From cd3435f0ba3d8b1ab8ee8ae018e597c11a1e4f05 Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Mon, 13 May 2024 10:56:21 +0300 Subject: [PATCH] improve descriptions Signed-off-by: ChrsMark --- .chloggen/merge_cpu_states.yaml | 2 +- model/registry/cpu.yaml | 3 +-- model/registry/deprecated/container.yaml | 2 +- model/registry/deprecated/process.yaml | 3 +-- model/registry/deprecated/system.yaml | 2 +- 5 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.chloggen/merge_cpu_states.yaml b/.chloggen/merge_cpu_states.yaml index 1c8ddef7b3..49ef1f48ee 100755 --- a/.chloggen/merge_cpu_states.yaml +++ b/.chloggen/merge_cpu_states.yaml @@ -10,7 +10,7 @@ change_type: breaking component: system # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). -note: Merge *.cpu.state attributes into a common cpu.state attribute +note: Rename `process.cpu.state`, `container.cpu.state`, and `system.cpu.state` attributes into a common `cpu.state` attribute # 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. diff --git a/model/registry/cpu.yaml b/model/registry/cpu.yaml index bd346a95f2..e81c9a9cbc 100644 --- a/model/registry/cpu.yaml +++ b/model/registry/cpu.yaml @@ -2,8 +2,7 @@ groups: - id: registry.cpu prefix: cpu type: attribute_group - brief: > - A cpu instance + brief: Attributes specific to a cpu instance. attributes: - id: state brief: "The state of the CPU" diff --git a/model/registry/deprecated/container.yaml b/model/registry/deprecated/container.yaml index 0f18e38643..a7f68c703f 100644 --- a/model/registry/deprecated/container.yaml +++ b/model/registry/deprecated/container.yaml @@ -10,7 +10,7 @@ groups: stability: experimental deprecated: "Replaced by `container.label`." - id: container.cpu.state - brief: "The CPU state for this data point." + brief: "Deprecated, use `cpu.state` instead." type: allow_custom_values: true members: diff --git a/model/registry/deprecated/process.yaml b/model/registry/deprecated/process.yaml index c473f3da4f..9836a0abe8 100644 --- a/model/registry/deprecated/process.yaml +++ b/model/registry/deprecated/process.yaml @@ -4,8 +4,7 @@ groups: brief: "Deprecated process attributes." attributes: - id: process.cpu.state - brief: > - The CPU state of the process. + brief: "Deprecated, use `cpu.state` instead." deprecated: 'Removed, report cpu state with `cpu.state` common attribute' type: allow_custom_values: true diff --git a/model/registry/deprecated/system.yaml b/model/registry/deprecated/system.yaml index 4941bd18eb..00304d607b 100644 --- a/model/registry/deprecated/system.yaml +++ b/model/registry/deprecated/system.yaml @@ -48,7 +48,7 @@ groups: - id: steal value: 'steal' stability: experimental - brief: "The state of the CPU" + brief: "Deprecated, use `cpu.state` instead." stability: experimental deprecated: 'Removed, report cpu state with `cpu.state` common attribute' examples: [ "idle", "interrupt" ]