Skip to content

feat: include reason label to kube_deployment_status_condition #2719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 14, 2025
+80 −23
Merged

feat: include reason label to kube_deployment_status_condition #2719

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a50cab
added reason label
Rishab87 Aug 4, 2025
b30335f
changing empty reasons to unkown
Rishab87 Aug 8, 2025
bc1e7f8
fixing empty reasons and adding tests
Rishab87 Aug 11, 2025
b582038
adding empty reason in allowedList
Rishab87 Aug 11, 2025
547afad
adding reasons from deployment_utils.go
Rishab87 Aug 13, 2025
012b46d
adding empty string in reasons
Rishab87 Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/metrics/workload/deployment-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| kube_deployment_status_replicas_unavailable | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
| kube_deployment_status_replicas_updated | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
| kube_deployment_status_observed_generation | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
| kube_deployment_status_condition | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; <br> `condition`=&lt;deployment-condition&gt; <br> `status`=&lt;true\|false\|unknown&gt; | STABLE |
| kube_deployment_status_condition | Gauge | | `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 |
| kube_deployment_spec_replicas | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
| kube_deployment_spec_paused | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
| kube_deployment_spec_strategy_rollingupdate_max_unavailable | Gauge | | `deployment`=&lt;deployment-name&gt; <br> `namespace`=&lt;deployment-namespace&gt; | STABLE |
Expand Down
17 changes: 15 additions & 2 deletions internal/store/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ var (
descDeploymentLabelsDefaultLabels = []string{"namespace", "deployment"}
)

var (
allowedDeploymentReasons = map[string]struct{}{
"MinimumReplicasAvailable": {},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at these strings again
https://github.com/kubernetes/kubernetes/blob/master/pkg/controller/deployment/util/deployment_util.go#L67

Can we refer to these here instead and create a complete list based on what's available in deployment_util.go?

Suggested change
var (
allowedDeploymentReasons = map[string]struct{}{
"MinimumReplicasAvailable": {},
import deploymentutil "k8s.io/kubernetes/pkg/controller/deployment/util"
var (
allowedDeploymentReasons = map[string]struct{}{
deploymentutil.MinimumReplicasAvailable: {},

Copy link
Contributor Author

@Rishab87 Rishab87 Aug 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrueg, When I'm trying to:

go get k8s.io/kubernetes/pkg/controller/deployment/util

I'm getting this:

k8s.io/controller-manager/pkg/features: reading k8s.io/controller-manager/go.mod at revision v0.0.0: unknown revision v0.0.0

Is this a good idea to use internal k8s packages directly? should I directly use strings?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, you're right!

Can you copy all other reasons over as a string and add a comment that they are taken from deployment_utils.go?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrueg thanks for the review, made the changes

"NewReplicaSetAvailable": {},
"FailedCreate": {},
}
)

func deploymentMetricFamilies(allowAnnotationsList, allowLabelsList []string) []generator.FamilyGenerator {
return []generator.FamilyGenerator{
*generator.NewFamilyGeneratorWithStability(
Expand Down Expand Up @@ -174,8 +182,13 @@ func deploymentMetricFamilies(allowAnnotationsList, allowLabelsList []string) []
for j, m := range conditionMetrics {
metric := m

metric.LabelKeys = []string{"condition", "status"}
metric.LabelValues = append([]string{string(c.Type)}, metric.LabelValues...)
reason := c.Reason
if _, ok := allowedDeploymentReasons[reason]; !ok {
Copy link
Member

@mrueg mrueg Aug 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it's empty, will it still be unknown?
Can you create a test with the reason field being empty as well as with one test with a non allowed deployment reason?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah that was the case earlier, fixed it if its empty then it will remain empty and will show unknown if reason is not in the allowed list, also added the tests for both cases.

reason = "unknown"
}

metric.LabelKeys = []string{"reason", "condition", "status"}
metric.LabelValues = append([]string{reason, string(c.Type)}, metric.LabelValues...)
ms[i*len(conditionStatuses)+j] = metric
}
}
Expand Down
74 changes: 54 additions & 20 deletions internal/store/deployment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import (
var (
depl1Replicas int32 = 200
depl2Replicas int32 = 5
depl3Replicas int32 = 1

depl1MaxUnavailable = intstr.FromInt(10)
depl2MaxUnavailable = intstr.FromString("25%")
Expand Down Expand Up @@ -98,8 +99,8 @@ func TestDeploymentStore(t *testing.T) {
UpdatedReplicas: 2,
ObservedGeneration: 111,
Conditions: []v1.DeploymentCondition{
{Type: v1.DeploymentAvailable, Status: corev1.ConditionTrue},
{Type: v1.DeploymentProgressing, Status: corev1.ConditionTrue},
{Type: v1.DeploymentAvailable, Status: corev1.ConditionTrue, Reason: "MinimumReplicasAvailable"},
{Type: v1.DeploymentProgressing, Status: corev1.ConditionTrue, Reason: "NewReplicaSetAvailable"},
},
},
Spec: v1.DeploymentSpec{
Expand All @@ -126,12 +127,12 @@ 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_condition{deployment="depl1",namespace="ns1",condition="Available",status="true"} 1
kube_deployment_status_condition{deployment="depl1",namespace="ns1",condition="Progressing",status="true"} 1
kube_deployment_status_condition{deployment="depl1",namespace="ns1",condition="Available",status="false"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",condition="Progressing",status="false"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",condition="Available",status="unknown"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",condition="Progressing",status="unknown"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",condition="Available",status="true"} 1
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="NewReplicaSetAvailable",condition="Progressing",status="true"} 1
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",condition="Available",status="false"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="NewReplicaSetAvailable",condition="Progressing",status="false"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="MinimumReplicasAvailable",condition="Available",status="unknown"} 0
kube_deployment_status_condition{deployment="depl1",namespace="ns1",reason="NewReplicaSetAvailable",condition="Progressing",status="unknown"} 0
`,
},
{
Expand All @@ -152,9 +153,9 @@ func TestDeploymentStore(t *testing.T) {
UpdatedReplicas: 1,
ObservedGeneration: 1111,
Conditions: []v1.DeploymentCondition{
{Type: v1.DeploymentAvailable, Status: corev1.ConditionFalse},
{Type: v1.DeploymentProgressing, Status: corev1.ConditionFalse},
{Type: v1.DeploymentReplicaFailure, Status: corev1.ConditionTrue},
{Type: v1.DeploymentAvailable, Status: corev1.ConditionFalse, Reason: "MinimumReplicasAvailable"},
{Type: v1.DeploymentProgressing, Status: corev1.ConditionFalse, Reason: "NewReplicaSetAvailable"},
{Type: v1.DeploymentReplicaFailure, Status: corev1.ConditionTrue, Reason: "FailedCreate"},
},
},
Spec: v1.DeploymentSpec{
Expand All @@ -180,17 +181,50 @@ func TestDeploymentStore(t *testing.T) {
kube_deployment_status_replicas_updated{deployment="depl2",namespace="ns2"} 1
kube_deployment_status_replicas{deployment="depl2",namespace="ns2"} 10
kube_deployment_status_replicas_ready{deployment="depl2",namespace="ns2"} 5
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Available",status="true"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Progressing",status="true"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="ReplicaFailure",status="true"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Available",status="false"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Progressing",status="false"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="ReplicaFailure",status="false"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Available",status="unknown"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="Progressing",status="unknown"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",condition="ReplicaFailure",status="unknown"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="MinimumReplicasAvailable",condition="Available",status="true"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="NewReplicaSetAvailable",condition="Progressing",status="true"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="FailedCreate",condition="ReplicaFailure",status="true"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="MinimumReplicasAvailable",condition="Available",status="false"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="NewReplicaSetAvailable",condition="Progressing",status="false"} 1
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="FailedCreate",condition="ReplicaFailure",status="false"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="MinimumReplicasAvailable",condition="Available",status="unknown"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="NewReplicaSetAvailable",condition="Progressing",status="unknown"} 0
kube_deployment_status_condition{deployment="depl2",namespace="ns2",reason="FailedCreate",condition="ReplicaFailure",status="unknown"} 0
`,
},
{
Obj: &v1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: "depl3",
Namespace: "ns3",
},
Status: v1.DeploymentStatus{
Conditions: []v1.DeploymentCondition{
{Type: v1.DeploymentAvailable, Status: corev1.ConditionFalse, Reason: "ThisReasonIsNotAllowed"},
{Type: v1.DeploymentProgressing, Status: corev1.ConditionTrue},
},
},
Spec: v1.DeploymentSpec{
Replicas: &depl3Replicas,
},
},
Want: metadata + `
kube_deployment_metadata_generation{deployment="depl3",namespace="ns3"} 0
kube_deployment_spec_paused{deployment="depl3",namespace="ns3"} 0
kube_deployment_spec_replicas{deployment="depl3",namespace="ns3"} 1
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Available",status="true"} 0
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Available",status="false"} 1
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Available",status="unknown"} 0
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Progressing",status="true"} 1
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Progressing",status="false"} 0
kube_deployment_status_condition{deployment="depl3",namespace="ns3",reason="unknown",condition="Progressing",status="unknown"} 0
kube_deployment_status_observed_generation{deployment="depl3",namespace="ns3"} 0
kube_deployment_status_replicas_available{deployment="depl3",namespace="ns3"} 0
kube_deployment_status_replicas_ready{deployment="depl3",namespace="ns3"} 0
kube_deployment_status_replicas_unavailable{deployment="depl3",namespace="ns3"} 0
kube_deployment_status_replicas_updated{deployment="depl3",namespace="ns3"} 0
kube_deployment_status_replicas{deployment="depl3",namespace="ns3"} 0`,
},
}

for i, c := range cases {
Expand Down