From aec1a007834cb5125085fec9b8e9fe5fa64b3d94 Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Sat, 14 Dec 2024 15:53:32 +0200 Subject: [PATCH] Add notes about resource correlation Signed-off-by: ChrsMark --- docs/system/k8s-metrics.md | 20 ++++++++++++++++---- model/k8s/metrics.yaml | 20 ++++++++++++++++---- 2 files changed, 32 insertions(+), 8 deletions(-) diff --git a/docs/system/k8s-metrics.md b/docs/system/k8s-metrics.md index 2aa24c9f0e..9c22854cab 100644 --- a/docs/system/k8s-metrics.md +++ b/docs/system/k8s-metrics.md @@ -345,7 +345,10 @@ This metric is [recommended][MetricRecommended]. | `k8s.daemonset.current_scheduled_nodes` | UpDownCounter | `{node}` | Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric aligns with the `currentNumberScheduled` field of the -[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) +[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + +This metric SHOULD, at a minimum, be reported against a +[`k8s.daemonset`](../resource/k8s.md#daemonset) resource. @@ -368,7 +371,10 @@ This metric is [recommended][MetricRecommended]. | `k8s.daemonset.desired_scheduled_nodes` | UpDownCounter | `{node}` | Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod) [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric aligns with the `desiredNumberScheduled` field of the -[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) +[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + +This metric SHOULD, at a minimum, be reported against a +[`k8s.daemonset`](../resource/k8s.md#daemonset) resource. @@ -391,7 +397,10 @@ This metric is [recommended][MetricRecommended]. | `k8s.daemonset.misscheduled_nodes` | UpDownCounter | `{node}` | Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric aligns with the `numberMisscheduled` field of the -[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) +[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + +This metric SHOULD, at a minimum, be reported against a +[`k8s.daemonset`](../resource/k8s.md#daemonset) resource. @@ -414,7 +423,10 @@ This metric is [recommended][MetricRecommended]. | `k8s.daemonset.ready_nodes` | UpDownCounter | `{node}` | Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric aligns with the `numberReady` field of the -[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) +[K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + +This metric SHOULD, at a minimum, be reported against a +[`k8s.daemonset`](../resource/k8s.md#daemonset) resource. diff --git a/model/k8s/metrics.yaml b/model/k8s/metrics.yaml index 600cbc0970..d59a8b860b 100644 --- a/model/k8s/metrics.yaml +++ b/model/k8s/metrics.yaml @@ -135,7 +135,10 @@ groups: brief: "Number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod" note: | This metric aligns with the `currentNumberScheduled` field of the - [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) + [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + + This metric SHOULD, at a minimum, be reported against a + [`k8s.daemonset`](../resource/k8s.md#daemonset) resource. instrument: updowncounter unit: "{node}" - id: metric.k8s.daemonset.desired_scheduled_nodes @@ -145,7 +148,10 @@ groups: brief: "Number of nodes that should be running the daemon pod (including nodes currently running the daemon pod)" note: | This metric aligns with the `desiredNumberScheduled` field of the - [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) + [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + + This metric SHOULD, at a minimum, be reported against a + [`k8s.daemonset`](../resource/k8s.md#daemonset) resource. instrument: updowncounter unit: "{node}" - id: metric.k8s.daemonset.misscheduled_nodes @@ -155,7 +161,10 @@ groups: brief: "Number of nodes that are running the daemon pod, but are not supposed to run the daemon pod" note: | This metric aligns with the `numberMisscheduled` field of the - [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) + [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + + This metric SHOULD, at a minimum, be reported against a + [`k8s.daemonset`](../resource/k8s.md#daemonset) resource. instrument: updowncounter unit: "{node}" - id: metric.k8s.daemonset.ready_nodes @@ -165,6 +174,9 @@ groups: brief: "Number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready" note: | This metric aligns with the `numberReady` field of the - [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps) + [K8s DaemonSetStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#daemonsetstatus-v1-apps). + + This metric SHOULD, at a minimum, be reported against a + [`k8s.daemonset`](../resource/k8s.md#daemonset) resource. instrument: updowncounter unit: "{node}"