[Metricbeat] Add state_statefulset replicas.ready

Toby McLaughlin · Toby McLaughlin · commit 5648c96faed7 · 2021-06-02T11:06:00.000+09:30
Add a "replicas.ready" field to the state_statefulset metricset of the
Kubernetes module.

This is drawn from the "readyReplicas" value in the Kubernetes
StatefulSetStatus API response.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -131,6 +131,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Add support for the MemoryPressure, DiskPressure, OutOfDisk and PIDPressure status conditions in state_node. {pull}23905[23905]
 - Remove xpack enabled flag on ES, Logstash, Beats and Kibana {pull}24427[24427]
 - Adjust host fields to adopt new names from 1.9.0 ECS. {pull}24312[24312]
+- Add replicas.ready field to state_statefulset in Kubernetes module{pull}26088[26088]
 
 *Packetbeat*
 
diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -37274,6 +37274,16 @@ type: long
 The number of desired replicas per StatefulSet
 
 
+type: long
+
+--
+
+*`kubernetes.statefulset.replicas.ready`*::
++
+--
+The number of ready replicas per StatefulSet
+
+
 type: long
 
 --
diff --git a/metricbeat/module/kubernetes/fields.go b/metricbeat/module/kubernetes/fields.go
diff --git a/metricbeat/module/kubernetes/state_statefulset/_meta/data.json b/metricbeat/module/kubernetes/state_statefulset/_meta/data.json
@@ -16,7 +16,8 @@
             "name": "mysql",
             "replicas": {
                 "desired": 5,
-                "observed": 2
+                "observed": 2,
+                "ready": 2
             }
         }
     },
diff --git a/metricbeat/module/kubernetes/state_statefulset/_meta/fields.yml b/metricbeat/module/kubernetes/state_statefulset/_meta/fields.yml
@@ -21,6 +21,10 @@
           type: long
           description: >
             The number of desired replicas per StatefulSet
+        - name: ready
+          type: long
+          description: >
+            The number of ready replicas per StatefulSet
     - name: generation
       type: group
       description: >
diff --git a/metricbeat/module/kubernetes/state_statefulset/_meta/test/ksm.v1.8.0.expected b/metricbeat/module/kubernetes/state_statefulset/_meta/test/ksm.v1.8.0.expected
@@ -13,7 +13,8 @@
 			"name": "web",
 			"replicas": {
 				"desired": 2,
-				"observed": 2
+				"observed": 2,
+				"ready": 2
 			}
 		},
 		"Index": "",
diff --git a/metricbeat/module/kubernetes/state_statefulset/_meta/testdata/docs.plain b/metricbeat/module/kubernetes/state_statefulset/_meta/testdata/docs.plain
@@ -462,3 +462,8 @@ kube_statefulset_status_observed_generation{namespace="custom",statefulset="mysq
 kube_statefulset_status_replicas{namespace="default",statefulset="elasticsearch"} 1
 kube_statefulset_status_replicas{namespace="default",statefulset="mysql"} 2
 kube_statefulset_status_replicas{namespace="custom",statefulset="mysql"} 3
+# HELP kube_statefulset_status_replicas_ready The number of ready replicas per StatefulSet.
+# TYPE kube_statefulset_status_replicas_ready gauge
+kube_statefulset_status_replicas_ready{namespace="default",statefulset="elasticsearch"} 1
+kube_statefulset_status_replicas_ready{namespace="default",statefulset="mysql"} 2
+kube_statefulset_status_replicas_ready{namespace="custom",statefulset="mysql"} 1
diff --git a/metricbeat/module/kubernetes/state_statefulset/_meta/testdata/docs.plain-expected.json b/metricbeat/module/kubernetes/state_statefulset/_meta/testdata/docs.plain-expected.json
@@ -16,7 +16,8 @@
                 "name": "mysql",
                 "replicas": {
                     "desired": 5,
-                    "observed": 2
+                    "observed": 2,
+                    "ready": 2
                 }
             }
         },
@@ -46,7 +47,8 @@
                 "name": "elasticsearch",
                 "replicas": {
                     "desired": 4,
-                    "observed": 1
+                    "observed": 1,
+                    "ready": 1
                 }
             }
         },
@@ -76,7 +78,8 @@
                 "name": "mysql",
                 "replicas": {
                     "desired": 6,
-                    "observed": 3
+                    "observed": 3,
+                    "ready": 1
                 }
             }
         },
diff --git a/metricbeat/module/kubernetes/state_statefulset/state_statefulset.go b/metricbeat/module/kubernetes/state_statefulset/state_statefulset.go
@@ -47,6 +47,7 @@ var (
 			"kube_statefulset_status_observed_generation": p.Metric("generation.observed"),
 			"kube_statefulset_replicas":                   p.Metric("replicas.desired"),
 			"kube_statefulset_status_replicas":            p.Metric("replicas.observed"),
+			"kube_statefulset_status_replicas_ready":      p.Metric("replicas.ready"),
 		},
 
 		Labels: map[string]p.LabelMap{

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@`
`16`	`16`	`"name": "mysql",`
`17`	`17`	`"replicas": {`
`18`	`18`	`"desired": 5,`
`19`		`- "observed": 2`
	`19`	`+ "observed": 2,`
	`20`	`+ "ready": 2`
`20`	`21`	`}`
`21`	`22`	`}`
`22`	`23`	`},`