Add ReadyReplicas metric to deployment metric family #1534

akshitgrover · 2021-07-19T17:23:58Z

Add ReadyReplicas field in Deployment status to deployment metrics
Depicts number of readyReplicas across all replicas sets owned by the deployment

Signed-off-by: Akshit Grover akshit.grover@appdynamics.com

What this PR does / why we need it:
Adds ReadyReplicas field in Deployment status to deployment metrics

Ready Replicas count is an insightful metric as it depicts the number of traffic serving pods for a particular deployment, This can be used in number of ways to compare across the board for troubleshooting

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
Increases cardinality as it add another metric in the deployment metrics family

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1522

k8s-ci-robot · 2021-07-19T17:24:00Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot · 2021-07-19T17:24:05Z

Welcome @akshitgrover!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

* Add ReadyReplicas field in Deployment status to deployment metrics family * Depicts number of readyReplicas across all replicas sets owned by the deployment Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

fpetkovski

Thanks for the contribution @akshitgrover. Besides the name of the metric, everything else looked already quite good.

internal/store/deployment.go

Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

fpetkovski · 2021-07-22T15:12:29Z

LGTM, cc @kubernetes/kube-state-metrics-maintainers

mrueg · 2021-07-22T15:19:45Z

Can you also update https://github.com/kubernetes/kube-state-metrics/blob/master/docs/deployment-metrics.md to include this metric?

Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

akshitgrover · 2021-07-22T18:04:25Z

Docs updated 👍🏽
cc @mrueg

mrueg · 2021-07-22T21:36:14Z

/approve

akshitgrover · 2021-07-23T06:16:48Z

@mrueg @fpetkovski
I was going through the PR process, I guess 'lgtm' label is needed to merge

lilic

Thanks, one suggestion. Otherwise lgtm.

docs/deployment-metrics.md

lilic · 2021-07-23T13:25:30Z

internal/store/deployment_test.go

@@ -169,6 +174,7 @@ func TestDeploymentStore(t *testing.T) {
        kube_deployment_status_replicas_unavailable{deployment="depl2",namespace="ns2"} 0
        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


Is ready always the same as kube_deployment_status_replicas_available? Judging by these tests at least? 🤔

@lilic
Available and Ready replicas count will not necessarily be same
Available replicas are more like a subset of ready replicas (Replicas which are ready for a certain amount of time configurable based on spec.minReadySeconds)

Change status for kube_deployment_status_replicas_ready to EXPERIMENTAL

akshitgrover · 2021-08-03T04:42:54Z

@lilic @fpetkovski @mrueg
If everything looks good
Can we add LGTM label to the PR, So that this gets merged
Thank you

fpetkovski · 2021-08-03T07:43:19Z

/lgtm

Thanks for the contribution 👍

k8s-ci-robot · 2021-08-03T07:43:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akshitgrover, fpetkovski, mrueg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mrueg]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

akshitgrover · 2021-08-03T07:53:00Z

Thank you @fpetkovski
This was my first PR in the Kubernetes org
Feels so good

* [FEATURE] Add --use-apiserver-cache flag to set resourceVersion=0 for ListWatch requests kubernetes#1548 * [FEATURE] Introduce metrics for Kubernetes object annotations kubernetes#1468 * [FEATURE] Introduce start time metric for containers in terminated state kubernetes#1519 * [FEATURE] Introduce metrics for cronjob job history limits kubernetes#1535 * [FEATURE] Add system_uuid dimension to kube_node_info metric kubernetes#1535 * [FEATURE] Add available replica metric for statefulsets kubernetes#1532 * [FEATURE] Add ready replica metric for deployments kubernetes#1534 * [CHANGE] Update go clients for Kubernetes to support 1.22 kubernetes#1545 * [CHANGE] Use new promlint package and update prometheus cli to 2.28.1 kubernetes#1531

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 19, 2021

k8s-ci-robot requested review from brancz and mrueg July 19, 2021 17:24

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 19, 2021

Add ReadyReplicas metric to deployment metric family

1c538a2

* Add ReadyReplicas field in Deployment status to deployment metrics family * Depicts number of readyReplicas across all replicas sets owned by the deployment Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

akshitgrover force-pushed the master branch from b01b232 to 1c538a2 Compare July 19, 2021 17:25

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 19, 2021

fpetkovski requested changes Jul 20, 2021

View reviewed changes

internal/store/deployment.go Outdated Show resolved Hide resolved

Fix deployment ready replicas metric name

f8be5e1

Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

Add kube_deployment_status_replicas_ready in the docs

8990d2e

Signed-off-by: Akshit Grover <akshit.grover2016@gmail.com>

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 22, 2021

lilic reviewed Jul 23, 2021

View reviewed changes

docs/deployment-metrics.md Outdated Show resolved Hide resolved

lilic reviewed Jul 23, 2021

View reviewed changes

Update deployment ready replicas metric status

4054191

Change status for kube_deployment_status_replicas_ready to EXPERIMENTAL

akshitgrover requested a review from lilic July 27, 2021 04:47

k8s-ci-robot assigned fpetkovski Aug 3, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 3, 2021

k8s-ci-robot merged commit 85bfbf0 into kubernetes:master Aug 3, 2021

mrueg mentioned this pull request Aug 19, 2021

*: Cut v2.2.0 release #1550

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ReadyReplicas metric to deployment metric family #1534

Add ReadyReplicas metric to deployment metric family #1534

akshitgrover commented Jul 19, 2021

k8s-ci-robot commented Jul 19, 2021

k8s-ci-robot commented Jul 19, 2021

fpetkovski left a comment

fpetkovski commented Jul 22, 2021

mrueg commented Jul 22, 2021

akshitgrover commented Jul 22, 2021

mrueg commented Jul 22, 2021

akshitgrover commented Jul 23, 2021

lilic left a comment

lilic Jul 23, 2021

akshitgrover Jul 26, 2021

akshitgrover commented Aug 3, 2021

fpetkovski commented Aug 3, 2021

k8s-ci-robot commented Aug 3, 2021

akshitgrover commented Aug 3, 2021

Add ReadyReplicas metric to deployment metric family #1534

Add ReadyReplicas metric to deployment metric family #1534

Conversation

akshitgrover commented Jul 19, 2021

k8s-ci-robot commented Jul 19, 2021

k8s-ci-robot commented Jul 19, 2021

fpetkovski left a comment

Choose a reason for hiding this comment

fpetkovski commented Jul 22, 2021

mrueg commented Jul 22, 2021

akshitgrover commented Jul 22, 2021

mrueg commented Jul 22, 2021

akshitgrover commented Jul 23, 2021

lilic left a comment

Choose a reason for hiding this comment

lilic Jul 23, 2021

Choose a reason for hiding this comment

akshitgrover Jul 26, 2021

Choose a reason for hiding this comment

akshitgrover commented Aug 3, 2021

fpetkovski commented Aug 3, 2021

k8s-ci-robot commented Aug 3, 2021

akshitgrover commented Aug 3, 2021