From eee691b1d99572714977825585849cce3d19812f Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Tue, 3 Dec 2024 14:55:01 +0200 Subject: [PATCH] add refs to k8s api Signed-off-by: ChrsMark --- docs/system/k8s-metrics.md | 20 ++++++++++++++++---- model/k8s/metrics.yaml | 12 ++++++++++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/system/k8s-metrics.md b/docs/system/k8s-metrics.md index 54b5434335..1da56bb2da 100644 --- a/docs/system/k8s-metrics.md +++ b/docs/system/k8s-metrics.md @@ -381,7 +381,10 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `k8s.deployment.desired` | Gauge | `{pod}` | Number of desired pods in this deployment | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `k8s.deployment.desired` | Gauge | `{pod}` | Number of desired pods in this deployment [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** This metric aligns with the `replicas` field of the +[K8s Deployment Spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentspec-v1-apps) @@ -401,7 +404,10 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `k8s.deployment.available` | Gauge | `{pod}` | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `k8s.deployment.available` | Gauge | `{pod}` | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** This metric aligns with the `readyReplicas` field of the +[K8s Deployment Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentstatus-v1-apps) @@ -425,7 +431,10 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `k8s.replicaset.desired` | Gauge | `{pod}` | Number of desired pods in this replicaset | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `k8s.replicaset.desired` | Gauge | `{pod}` | Number of desired pods in this replicaset [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** This metric aligns with the `replicas` field of the +[K8s ReplicaSet Spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetspec-v1-apps) @@ -445,7 +454,10 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `k8s.replicaset.available` | Gauge | `{pod}` | Total number of available pods (ready for at least minReadySeconds) targeted by this replicaset | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `k8s.replicaset.available` | Gauge | `{pod}` | Total number of available pods (ready for at least minReadySeconds) targeted by this replicaset [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** This metric aligns with the `readyReplicas` field of the +[K8s ReplicaSet Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetstatus-v1-apps) diff --git a/model/k8s/metrics.yaml b/model/k8s/metrics.yaml index 37e46f7d36..ef39984dfc 100644 --- a/model/k8s/metrics.yaml +++ b/model/k8s/metrics.yaml @@ -133,6 +133,9 @@ groups: metric_name: k8s.deployment.desired stability: experimental brief: "Number of desired pods in this deployment" + note: | + This metric aligns with the `replicas` field of the + [K8s Deployment Spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentspec-v1-apps) instrument: gauge unit: "{pod}" - id: metric.k8s.deployment.available @@ -140,6 +143,9 @@ groups: metric_name: k8s.deployment.available stability: experimental brief: "Total number of available pods (ready for at least minReadySeconds) targeted by this deployment" + note: | + This metric aligns with the `readyReplicas` field of the + [K8s Deployment Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#deploymentstatus-v1-apps) instrument: gauge unit: "{pod}" @@ -149,6 +155,9 @@ groups: metric_name: k8s.replicaset.desired stability: experimental brief: "Number of desired pods in this replicaset" + note: | + This metric aligns with the `replicas` field of the + [K8s ReplicaSet Spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetspec-v1-apps) instrument: gauge unit: "{pod}" - id: metric.k8s.replicaset.available @@ -156,5 +165,8 @@ groups: metric_name: k8s.replicaset.available stability: experimental brief: "Total number of available pods (ready for at least minReadySeconds) targeted by this replicaset" + note: | + This metric aligns with the `readyReplicas` field of the + [K8s ReplicaSet Status](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#replicasetstatus-v1-apps) instrument: gauge unit: "{pod}"