add kube_deployment_status_replicas_terminating and kube_replicaset_status_terminating_replicas metrics

Author: atiratree

internal/store/deployment.go

@@ -160,6 +160,26 @@ func deploymentMetricFamilies(allowAnnotationsList, allowLabelsList []string) []
 				}
 			}),
 		),
+		*generator.NewFamilyGeneratorWithStability(
+			"kube_deployment_status_replicas_terminating",
+			"The number of terminating replicas per deployment.",
+			metric.Gauge,
+			basemetrics.ALPHA,
+			"",
+			wrapDeploymentFunc(func(r *v1.Deployment) *metric.Family {
+				ms := []*metric.Metric{}
+
+				if r.Status.TerminatingReplicas != nil {
+					ms = append(ms, &metric.Metric{
+						Value: float64(*r.Status.TerminatingReplicas),
+					})
+				}
+
+				return &metric.Family{
+					Metrics: ms,
+				}
+			}),
+		),
 		*generator.NewFamilyGeneratorWithStability(
 			"kube_deployment_status_observed_generation",
 			"The generation observed by the deployment controller.",

internal/store/deployment_test.go

@@ -24,6 +24,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
+	"k8s.io/utils/ptr"
 
 	generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
 )
@@ -59,6 +60,8 @@ func TestDeploymentStore(t *testing.T) {
 		# TYPE kube_deployment_status_replicas gauge
 		# HELP kube_deployment_status_replicas_ready [STABLE] The number of ready replicas per deployment.
 		# TYPE kube_deployment_status_replicas_ready gauge
+	    # HELP kube_deployment_status_replicas_terminating The number of terminating replicas per deployment.
+        # TYPE kube_deployment_status_replicas_terminating gauge
 		# HELP kube_deployment_status_replicas_available [STABLE] The number of available replicas per deployment.
 		# TYPE kube_deployment_status_replicas_available gauge
 		# HELP kube_deployment_status_replicas_unavailable [STABLE] The number of unavailable replicas per deployment.
@@ -100,6 +103,7 @@ func TestDeploymentStore(t *testing.T) {
 					AvailableReplicas:   10,
 					UnavailableReplicas: 5,
 					UpdatedReplicas:     2,
+					TerminatingReplicas: ptr.To[int32](3),
 					ObservedGeneration:  111,
 					Conditions: []v1.DeploymentCondition{
 						{Type: v1.DeploymentAvailable, Status: corev1.ConditionTrue, Reason: "MinimumReplicasAvailable"},
@@ -130,6 +134,7 @@ func TestDeploymentStore(t *testing.T) {
         kube_deployment_status_replicas_updated{deployment="depl1",namespace="ns1"} 2
         kube_deployment_status_replicas{deployment="depl1",namespace="ns1"} 15
         kube_deployment_status_replicas_ready{deployment="depl1",namespace="ns1"} 10
+        kube_deployment_status_replicas_terminating{deployment="depl1",namespace="ns1"} 3
         kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="true"} 1
         kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="false"} 0
         kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="unknown"} 0
@@ -154,6 +159,7 @@ func TestDeploymentStore(t *testing.T) {
 					AvailableReplicas:   5,
 					UnavailableReplicas: 0,
 					UpdatedReplicas:     1,
+					TerminatingReplicas: nil,
 					ObservedGeneration:  1111,
 					Conditions: []v1.DeploymentCondition{
 						{Type: v1.DeploymentAvailable, Status: corev1.ConditionFalse, Reason: "MinimumReplicasUnavailable"},

internal/store/replicaset.go

@@ -112,6 +112,26 @@ func replicaSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) []
 				}
 			}),
 		),
+		*generator.NewFamilyGeneratorWithStability(
+			"kube_replicaset_status_terminating_replicas",
+			"The number of terminating replicas per ReplicaSet.",
+			metric.Gauge,
+			basemetrics.ALPHA,
+			"",
+			wrapReplicaSetFunc(func(r *v1.ReplicaSet) *metric.Family {
+				ms := []*metric.Metric{}
+
+				if r.Status.TerminatingReplicas != nil {
+					ms = append(ms, &metric.Metric{
+						Value: float64(*r.Status.TerminatingReplicas),
+					})
+				}
+
+				return &metric.Family{
+					Metrics: ms,
+				}
+			}),
+		),
 		*generator.NewFamilyGeneratorWithStability(
 			"kube_replicaset_status_observed_generation",
 			"The generation observed by the ReplicaSet controller.",

internal/store/replicaset_test.go

@@ -22,6 +22,7 @@ import (
 
 	v1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/ptr"
 
 	generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
 )
@@ -43,11 +44,13 @@ func TestReplicaSetStore(t *testing.T) {
 		# HELP kube_replicaset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state.
 		# TYPE kube_replicaset_metadata_generation gauge
 		# HELP kube_replicaset_status_replicas [STABLE] The number of replicas per ReplicaSet.
+        # HELP kube_replicaset_status_terminating_replicas The number of terminating replicas per ReplicaSet.
 		# TYPE kube_replicaset_status_replicas gauge
 		# HELP kube_replicaset_status_fully_labeled_replicas [STABLE] The number of fully labeled replicas per ReplicaSet.
 		# TYPE kube_replicaset_status_fully_labeled_replicas gauge
 		# HELP kube_replicaset_status_ready_replicas [STABLE] The number of ready replicas per ReplicaSet.
 		# TYPE kube_replicaset_status_ready_replicas gauge
+        # TYPE kube_replicaset_status_terminating_replicas gauge
 		# HELP kube_replicaset_status_observed_generation [STABLE] The generation observed by the ReplicaSet controller.
 		# TYPE kube_replicaset_status_observed_generation gauge
 		# HELP kube_replicaset_spec_replicas [STABLE] Number of desired pods for a ReplicaSet.
@@ -80,6 +83,7 @@ func TestReplicaSetStore(t *testing.T) {
 					Replicas:             5,
 					FullyLabeledReplicas: 10,
 					ReadyReplicas:        5,
+					TerminatingReplicas:  ptr.To[int32](3),
 					ObservedGeneration:   1,
 				},
 				Spec: v1.ReplicaSetSpec{
@@ -93,6 +97,7 @@ func TestReplicaSetStore(t *testing.T) {
 				kube_replicaset_status_observed_generation{namespace="ns1",replicaset="rs1"} 1
 				kube_replicaset_status_fully_labeled_replicas{namespace="ns1",replicaset="rs1"} 10
 				kube_replicaset_status_ready_replicas{namespace="ns1",replicaset="rs1"} 5
+                kube_replicaset_status_terminating_replicas{namespace="ns1",replicaset="rs1"} 3
 				kube_replicaset_spec_replicas{namespace="ns1",replicaset="rs1"} 5
 				kube_replicaset_owner{namespace="ns1",owner_is_controller="true",owner_kind="Deployment",owner_name="dp-name",replicaset="rs1"} 1
 `,
@@ -112,6 +117,7 @@ func TestReplicaSetStore(t *testing.T) {
 					Replicas:             0,
 					FullyLabeledReplicas: 5,
 					ReadyReplicas:        0,
+					TerminatingReplicas:  nil,
 					ObservedGeneration:   5,
 				},
 				Spec: v1.ReplicaSetSpec{