Skip to content

Commit 643c9e9

Browse files
atiratreeatiratree
committed
add kube_deployment_status_replicas_terminating and kube_replicaset_status_terminating_replicas metrics
1 parent 941c683 commit 643c9e9

File tree

6 files changed

+54
-0
lines changed

6 files changed

+54
-0
lines changed

‎docs/metrics/workload/deployment-metrics.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
| kube_deployment_status_replicas_available | Gauge | The number of available replicas per deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
99
| kube_deployment_status_replicas_unavailable | Gauge | The number of unavailable replicas per deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
1010
| kube_deployment_status_replicas_updated | Gauge | The number of updated replicas per deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
11+
| kube_deployment_status_replicas_terminating | Gauge | The number of terminating replicas per deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | ALPHA |
1112
| kube_deployment_status_observed_generation | Gauge | The generation observed by the deployment controller. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
1213
| kube_deployment_status_condition | Gauge | The current status conditions of a deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; <br> `reason`=&lt;deployment-transition-reason&gt; <br> `condition`=&lt;deployment-condition&gt; <br> `status`=&lt;true\|false\|unknown&gt; | STABLE |
1314
| kube_deployment_spec_replicas | Gauge | Number of desired pods for a deployment. | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |

‎docs/metrics/workload/replicaset-metrics.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
| kube_replicaset_status_replicas | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |
77
| kube_replicaset_status_fully_labeled_replicas | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |
88
| kube_replicaset_status_ready_replicas | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |
9+
| kube_replicaset_status_terminating_replicas | Gauge | The number of terminating replicas per ReplicaSet. | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | ALPHA |
910
| kube_replicaset_status_observed_generation | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |
1011
| kube_replicaset_spec_replicas | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |
1112
| kube_replicaset_metadata_generation | Gauge | | `replicaset`=&lt;replicaset-name&gt; <br> `namespace`=&lt;replicaset-namespace&gt; | STABLE |

‎internal/store/deployment.go‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,26 @@ func deploymentMetricFamilies(allowAnnotationsList, allowLabelsList []string) []
160160
}
161161
}),
162162
),
163+
*generator.NewFamilyGeneratorWithStability(
164+
"kube_deployment_status_replicas_terminating",
165+
"The number of terminating replicas per deployment.",
166+
metric.Gauge,
167+
basemetrics.ALPHA,
168+
"",
169+
wrapDeploymentFunc(func(r *v1.Deployment) *metric.Family {
170+
ms := []*metric.Metric{}
171+
172+
if r.Status.TerminatingReplicas != nil {
173+
ms = append(ms, &metric.Metric{
174+
Value: float64(*r.Status.TerminatingReplicas),
175+
})
176+
}
177+
178+
return &metric.Family{
179+
Metrics: ms,
180+
}
181+
}),
182+
),
163183
*generator.NewFamilyGeneratorWithStability(
164184
"kube_deployment_status_observed_generation",
165185
"The generation observed by the deployment controller.",

‎internal/store/deployment_test.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import (
2424
corev1 "k8s.io/api/core/v1"
2525
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2626
"k8s.io/apimachinery/pkg/util/intstr"
27+
"k8s.io/utils/ptr"
2728

2829
generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
2930
)
@@ -59,6 +60,8 @@ func TestDeploymentStore(t *testing.T) {
5960
# TYPE kube_deployment_status_replicas gauge
6061
# HELP kube_deployment_status_replicas_ready [STABLE] The number of ready replicas per deployment.
6162
# TYPE kube_deployment_status_replicas_ready gauge
63+
# HELP kube_deployment_status_replicas_terminating The number of terminating replicas per deployment.
64+
# TYPE kube_deployment_status_replicas_terminating gauge
6265
# HELP kube_deployment_status_replicas_available [STABLE] The number of available replicas per deployment.
6366
# TYPE kube_deployment_status_replicas_available gauge
6467
# HELP kube_deployment_status_replicas_unavailable [STABLE] The number of unavailable replicas per deployment.
@@ -100,6 +103,7 @@ func TestDeploymentStore(t *testing.T) {
100103
AvailableReplicas: 10,
101104
UnavailableReplicas: 5,
102105
UpdatedReplicas: 2,
106+
TerminatingReplicas: ptr.To[int32](3),
103107
ObservedGeneration: 111,
104108
Conditions: []v1.DeploymentCondition{
105109
{Type: v1.DeploymentAvailable, Status: corev1.ConditionTrue, Reason: "MinimumReplicasAvailable"},
@@ -130,6 +134,7 @@ func TestDeploymentStore(t *testing.T) {
130134
kube_deployment_status_replicas_updated{deployment="depl1",namespace="ns1"} 2
131135
kube_deployment_status_replicas{deployment="depl1",namespace="ns1"} 15
132136
kube_deployment_status_replicas_ready{deployment="depl1",namespace="ns1"} 10
137+
kube_deployment_status_replicas_terminating{deployment="depl1",namespace="ns1"} 3
133138
kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="true"} 1
134139
kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="false"} 0
135140
kube_deployment_status_condition{condition="Available",deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",status="unknown"} 0
@@ -154,6 +159,7 @@ func TestDeploymentStore(t *testing.T) {
154159
AvailableReplicas: 5,
155160
UnavailableReplicas: 0,
156161
UpdatedReplicas: 1,
162+
TerminatingReplicas: nil,
157163
ObservedGeneration: 1111,
158164
Conditions: []v1.DeploymentCondition{
159165
{Type: v1.DeploymentAvailable, Status: corev1.ConditionFalse, Reason: "MinimumReplicasUnavailable"},

‎internal/store/replicaset.go‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,26 @@ func replicaSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) []
112112
}
113113
}),
114114
),
115+
*generator.NewFamilyGeneratorWithStability(
116+
"kube_replicaset_status_terminating_replicas",
117+
"The number of terminating replicas per ReplicaSet.",
118+
metric.Gauge,
119+
basemetrics.ALPHA,
120+
"",
121+
wrapReplicaSetFunc(func(r *v1.ReplicaSet) *metric.Family {
122+
ms := []*metric.Metric{}
123+
124+
if r.Status.TerminatingReplicas != nil {
125+
ms = append(ms, &metric.Metric{
126+
Value: float64(*r.Status.TerminatingReplicas),
127+
})
128+
}
129+
130+
return &metric.Family{
131+
Metrics: ms,
132+
}
133+
}),
134+
),
115135
*generator.NewFamilyGeneratorWithStability(
116136
"kube_replicaset_status_observed_generation",
117137
"The generation observed by the ReplicaSet controller.",

‎internal/store/replicaset_test.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222

2323
v1 "k8s.io/api/apps/v1"
2424
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
25+
"k8s.io/utils/ptr"
2526

2627
generator "k8s.io/kube-state-metrics/v2/pkg/metric_generator"
2728
)
@@ -43,11 +44,13 @@ func TestReplicaSetStore(t *testing.T) {
4344
# HELP kube_replicaset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state.
4445
# TYPE kube_replicaset_metadata_generation gauge
4546
# HELP kube_replicaset_status_replicas [STABLE] The number of replicas per ReplicaSet.
47+
# HELP kube_replicaset_status_terminating_replicas The number of terminating replicas per ReplicaSet.
4648
# TYPE kube_replicaset_status_replicas gauge
4749
# HELP kube_replicaset_status_fully_labeled_replicas [STABLE] The number of fully labeled replicas per ReplicaSet.
4850
# TYPE kube_replicaset_status_fully_labeled_replicas gauge
4951
# HELP kube_replicaset_status_ready_replicas [STABLE] The number of ready replicas per ReplicaSet.
5052
# TYPE kube_replicaset_status_ready_replicas gauge
53+
# TYPE kube_replicaset_status_terminating_replicas gauge
5154
# HELP kube_replicaset_status_observed_generation [STABLE] The generation observed by the ReplicaSet controller.
5255
# TYPE kube_replicaset_status_observed_generation gauge
5356
# HELP kube_replicaset_spec_replicas [STABLE] Number of desired pods for a ReplicaSet.
@@ -80,6 +83,7 @@ func TestReplicaSetStore(t *testing.T) {
8083
Replicas: 5,
8184
FullyLabeledReplicas: 10,
8285
ReadyReplicas: 5,
86+
TerminatingReplicas: ptr.To[int32](3),
8387
ObservedGeneration: 1,
8488
},
8589
Spec: v1.ReplicaSetSpec{
@@ -93,6 +97,7 @@ func TestReplicaSetStore(t *testing.T) {
9397
kube_replicaset_status_observed_generation{namespace="ns1",replicaset="rs1"} 1
9498
kube_replicaset_status_fully_labeled_replicas{namespace="ns1",replicaset="rs1"} 10
9599
kube_replicaset_status_ready_replicas{namespace="ns1",replicaset="rs1"} 5
100+
kube_replicaset_status_terminating_replicas{namespace="ns1",replicaset="rs1"} 3
96101
kube_replicaset_spec_replicas{namespace="ns1",replicaset="rs1"} 5
97102
kube_replicaset_owner{namespace="ns1",owner_is_controller="true",owner_kind="Deployment",owner_name="dp-name",replicaset="rs1"} 1
98103
`,
@@ -112,6 +117,7 @@ func TestReplicaSetStore(t *testing.T) {
112117
Replicas: 0,
113118
FullyLabeledReplicas: 5,
114119
ReadyReplicas: 0,
120+
TerminatingReplicas: nil,
115121
ObservedGeneration: 5,
116122
},
117123
Spec: v1.ReplicaSetSpec{

0 commit comments

Comments
 (0)