ISSUE-1465: Added kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1482

sgrzemski · 2021-05-17T08:06:06Z

What this PR does / why we need it:

Adds kube_pod_status_ready_time and kube_pod_status_containers_ready_time metrics to get the information provided by Pod Lifecycle's PodConditions array.

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 #1465

k8s-ci-robot · 2021-05-17T08:06:09Z

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-05-17T08:06:13Z

Welcome @sgrzemski!

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. 😃

k8s-ci-robot · 2021-05-17T08:06:20Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sgrzemski
To complete the pull request process, please assign tariq1890 after the PR has been reviewed.
You can assign the PR to them by writing /assign @tariq1890 in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

mrueg · 2021-05-17T08:28:50Z

docs/pod-metrics.md

@@ -9,6 +9,8 @@
 | kube_pod_labels | Gauge | Kubernetes labels converted to Prometheus labels | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `label_POD_LABEL`=&lt;POD_LABEL&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
 | kube_pod_status_phase | Gauge | The pods current phase | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `phase`=&lt;Pending\|Running\|Succeeded\|Failed\|Unknown&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
 | kube_pod_status_ready | Gauge | Describes whether the pod is ready to serve requests | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `condition`=&lt;true\|false\|unknown&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
+| kube_pod_status_ready_time | Gauge | Time when pod passed readiness probes. | seconds | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
+| kube_pod_status_containers_ready_time | Gauge | Time when pod containers entered Ready state. | seconds | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |


Hello @mrueg,
The k8s documentation specifies this particular condition as

ContainersReady: all containers in the Pod are ready.

, hence the plural. Due to the fact there can be more than 1 containers in a pod and this condition turns into true only when all pods are ready, I think we should stick with plural. What do you think? If you still want to stick with singular that's fine for me as well, but I found it a little bit confusing.

Thanks, good point! I'll defer to @lilic @brancz and @tariq1890 if we want to stick closer to k8s or not

I would prefer keeping to how we have it in kube-state-metrics which is kube_pod_container_info, but up to @brancz and @mrueg .

mrueg · 2021-05-18T10:26:31Z

@sgrzemski can you also sign the linuxfoundation/cla?

lilic

Couple of comments. Thanks for the PR!

What is the cardinality of these new metrics?

internal/store/pod.go

lilic · 2021-05-18T12:02:48Z

internal/store/pod.go

@@ -1362,6 +1364,32 @@ func createPodStartTimeFamilyGenerator() generator.FamilyGenerator {
 	)
 }

+func createPodStatusContainersReadyTimeFamilyGenerator() generator.FamilyGenerator {


Could you add a test for both of these, thank you!

Added, thank you!

internal/store/pod.go

lilic · 2021-05-18T12:05:39Z

docs/pod-metrics.md

@@ -9,6 +9,8 @@
 | kube_pod_labels | Gauge | Kubernetes labels converted to Prometheus labels | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `label_POD_LABEL`=&lt;POD_LABEL&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
 | kube_pod_status_phase | Gauge | The pods current phase | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `phase`=&lt;Pending\|Running\|Succeeded\|Failed\|Unknown&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
 | kube_pod_status_ready | Gauge | Describes whether the pod is ready to serve requests | | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `condition`=&lt;true\|false\|unknown&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
+| kube_pod_status_ready_time | Gauge | Time when pod passed readiness probes. | seconds | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |
+| kube_pod_status_containers_ready_time | Gauge | Time when pod containers entered Ready state. | seconds | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt; | STABLE |


I would prefer keeping to how we have it in kube-state-metrics which is kube_pod_container_info, but up to @brancz and @mrueg .

…_time

…ners_ready_time

sgrzemski · 2021-05-18T13:47:08Z

@sgrzemski can you also sign the linuxfoundation/cla?

Done. Thank you for pointing that out, my initial try was unsuccessful. I've retried today and succeeded.

k8s-triage-robot · 2021-08-16T15:34:00Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-ci-robot · 2021-08-19T20:11:52Z

@sgrzemski: PR needs rebase.

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.

k8s-triage-robot · 2021-09-18T20:40:03Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2021-10-18T21:02:57Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen
Mark this issue or PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2021-10-18T21:03:16Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue or PR with /reopen

Mark this issue or PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.

ankitpatel96 · 2022-01-12T22:20:30Z

Hi @sgrzemski - this would be really useful for my organization. Is there any chance you can get this across the line? If not I'd be happy to take over the PR and get it merged.

aliaksei-karneyeu · 2022-02-28T16:22:15Z

@mrueg could you maybe have a look on it and merge, as it's still needed.

BartVB · 2022-06-02T07:00:18Z

It seems like all that's needed is an opinion from @brancz about:

#1482 (comment)

GopiChandra25 · 2022-09-16T14:00:42Z

@k8s-ci-robot / @mrueg and Team,
Can someone please help me we have to evaluate Pod startuptime (total time that pod tooks to up and running )using kube statemetrics, is there any metrics ?

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

k8s-ci-robot requested review from brancz and mrueg May 17, 2021 08:06

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 17, 2021

mrueg reviewed May 17, 2021

View reviewed changes

sgrzemski requested a review from mrueg May 17, 2021 08:39

lilic reviewed May 18, 2021

View reviewed changes

Added kube_pod_status_ready_time and kube_pod_status_containers_ready…

6379aab

…_time

sgrzemski force-pushed the issue-1465 branch from 49cb80b to 6379aab Compare May 18, 2021 12:44

sgrzemski added 2 commits May 18, 2021 14:45

Applied gofmt

af5241f

Added tests for kube_pod_status_ready_time and kube_pod_status_contai…

a0fb2b4

…ners_ready_time

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 May 18, 2021

sgrzemski requested a review from lilic May 18, 2021 13:47

Added two more families, so I had to fix benchamrk tests

1d33b0f

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 16, 2021

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 19, 2021

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 18, 2021

k8s-ci-robot closed this Oct 18, 2021

liangyuanpeng mentioned this pull request Sep 18, 2022

Add metrics of kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1837

Closed

ryanrolds mentioned this pull request Dec 29, 2022

Add metrics of kube_pod_status_ready_time and kube_pod_status_containers_ready_time redux #1938

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ISSUE-1465: Added kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1482

ISSUE-1465: Added kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1482

sgrzemski commented May 17, 2021

k8s-ci-robot commented May 17, 2021

k8s-ci-robot commented May 17, 2021

k8s-ci-robot commented May 17, 2021

mrueg May 17, 2021 •

edited

Loading

sgrzemski May 17, 2021

mrueg May 17, 2021

lilic May 18, 2021

mrueg commented May 18, 2021

lilic left a comment

lilic May 18, 2021

sgrzemski May 18, 2021

lilic May 18, 2021

sgrzemski commented May 18, 2021

k8s-triage-robot commented Aug 16, 2021

k8s-ci-robot commented Aug 19, 2021

k8s-triage-robot commented Sep 18, 2021

k8s-triage-robot commented Oct 18, 2021

k8s-ci-robot commented Oct 18, 2021

ankitpatel96 commented Jan 12, 2022

aliaksei-karneyeu commented Feb 28, 2022

BartVB commented Jun 2, 2022

GopiChandra25 commented Sep 16, 2022

	\| kube_pod_status_containers_ready_time \| Gauge \| Time when pod containers entered Ready state. \| seconds \| `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `uid`=<pod-uid> \| STABLE \|
	\| kube_pod_status_container_ready_time \| Gauge \| Time when the container of the pod entered Ready state. \| seconds \| `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `uid`=<pod-uid> \| STABLE \|

ISSUE-1465: Added kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1482

ISSUE-1465: Added kube_pod_status_ready_time and kube_pod_status_containers_ready_time #1482

Conversation

sgrzemski commented May 17, 2021

k8s-ci-robot commented May 17, 2021

k8s-ci-robot commented May 17, 2021

k8s-ci-robot commented May 17, 2021

mrueg May 17, 2021 • edited Loading

Choose a reason for hiding this comment

sgrzemski May 17, 2021

Choose a reason for hiding this comment

mrueg May 17, 2021

Choose a reason for hiding this comment

lilic May 18, 2021

Choose a reason for hiding this comment

mrueg commented May 18, 2021

lilic left a comment

Choose a reason for hiding this comment

lilic May 18, 2021

Choose a reason for hiding this comment

sgrzemski May 18, 2021

Choose a reason for hiding this comment

lilic May 18, 2021

Choose a reason for hiding this comment

sgrzemski commented May 18, 2021

k8s-triage-robot commented Aug 16, 2021

k8s-ci-robot commented Aug 19, 2021

k8s-triage-robot commented Sep 18, 2021

k8s-triage-robot commented Oct 18, 2021

k8s-ci-robot commented Oct 18, 2021

ankitpatel96 commented Jan 12, 2022

aliaksei-karneyeu commented Feb 28, 2022

BartVB commented Jun 2, 2022

GopiChandra25 commented Sep 16, 2022

mrueg May 17, 2021 •

edited

Loading