fix: Support scraping pods metrics that is still in scheduling status and has no assigned node #2217

mickeyzzc · 2023-10-11T05:56:56Z

What this PR does / why we need it:

When daemonset is used to scrape the metrics of pods, it can only scrape the metrics of pods assigned to nodes, but in scheduling, for example, pods in pending state cannot be scraped.
This results in pending pods with no indicators to observe and alert.
This pr adds a configuration parameter that, when enabled, captures pending pods from apiservice.

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

linux-foundation-easycla · 2023-10-11T05:57:02Z

The committers listed above are authorized under a signed CLA.

✅ login: mickeyzzc / name: MickeyZZC (82f5679, f8b0cb7, 539f57d, d33929e, 5fc87fa, f7ca990, d1f04c2, ad0e06c)
✅ login: mrueg / name: Manuel Rüger (37ceaf4)

k8s-ci-robot · 2023-10-11T05:57:04Z

Welcome @mickeyzzc!

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

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

examples/daemonsetsharding/deployment-no-node-pods.yaml

CatherineF-dev · 2023-10-11T13:34:19Z

Cool! Thanks for it!
We also found Daemonset sharding loses pod metrics who don't have assigned node. Just found it can be fixed by this PR.

CatherineF-dev · 2023-10-11T13:36:36Z

/assign @CatherineF-dev

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

examples/daemonsetsharding/deployment-no-node-pods.yaml

pkg/options/options.go

pkg/options/types.go

CatherineF-dev · 2023-10-12T15:15:08Z

pkg/options/types.go

-	return EmptyFieldSelector()
+	pattern := "[^a-zA-Z0-9_,-]+"
+	re := regexp.MustCompile(pattern)
+	result := re.ReplaceAllString(n.String(), "")


QQ: why we need re.ReplaceAllString(n.String(), "")

nit: remove re.ReplaceAllString(n.String(), ""). If node name isn't correct, keep it as before. Then users can know node name isn't correct.

QQ: why we need re.ReplaceAllString(n.String(), "")

There are two considerations for regularization here:

Handle the difference between "" and nil

Correction of node name

QQ: could you give two examples for these two cases?

We shouldn't change node name, which users are not aware of.

Ping~

Keep node name as same from input, or return errors during validation. We should not hide errors.

@mickeyzzc can you address this comment?

pkg/options/types_test.go

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

CatherineF-dev · 2023-10-12T15:26:11Z

Cool! Seems we can make it without an extra flag.

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

examples/daemonsetsharding/deployment-no-node-pods.yaml

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

dashpole · 2023-10-19T16:55:55Z

/triage accepted

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

mickeyzzc · 2023-11-17T11:41:53Z

/triage accepted

@dashpole Do I need your approval to merge again?

dashpole · 2023-11-17T13:52:13Z

@mickeyzzc I just did triage, to ensure the PR has an appropriate assignee. You will need approval from the reviewers and assignees on the PR to merge.

k8s-ci-robot · 2023-11-21T14:19:04Z

@mickeyzzc: you cannot LGTM your own PR.

In response to this:

/lgtm

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.

mickeyzzc · 2023-11-21T14:22:53Z

@mickeyzzc I just did triage, to ensure the PR has an appropriate assignee. You will need approval from the reviewers and assignees on the PR to merge.

@mrueg Can you help with the merger?

mrueg · 2023-11-22T10:03:18Z

To my understanding, when someone runs the daemonset for pod metrics, you suggest to have an additional deployment with --node="" to track unassigned pods?

Isn't it simpler to include pod metrics with --node="" in the regular ksm deployment that is already there additionally to the DS or does it make sense to have an additional deployment? (I'm not sure how users use this in terms of their metric storage system. @CatherineF-dev might be able to provide insights)

And before we can merge, can you update the README so users know how to apply this?
https://github.com/kubernetes/kube-state-metrics#daemonset-sharding-for-pod-metrics

CatherineF-dev · 2023-11-22T14:19:41Z

Isn't it simpler to include pod metrics with --node="" in the regular ksm deployment that is already there additionally to the DS or does it make sense to have an additional deployment?

Yes, this PR wants to fix --node="" to not select any nodes. Without this CL, --node="" collects all nodes.

CatherineF-dev · 2023-11-22T14:20:34Z

I left one comment here https://github.com/kubernetes/kube-state-metrics/pull/2217/files#r1399988722 that keeping node name as same from input, or return errors during validation.

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

mickeyzzc · 2023-11-23T13:44:56Z

And before we can merge, can you update the README so users know how to apply this?
https://github.com/kubernetes/kube-state-metrics#daemonset-sharding-for-pod-metrics

@mrueg completed

mrueg · 2023-12-18T10:51:06Z

README.md

@@ -276,6 +276,21 @@ spec:
              fieldPath: spec.nodeName
 ```

+To track metrics for unassigned pods, you need to add an additional deployment and set `--node=""`, as shown in the following example:
+```


@mickeyzzc can you add an empty line before the codeblock to fix the lint? Thanks!

README.md

mrueg · 2023-12-19T18:49:17Z

/lgtm

Thank you for your contribution!

k8s-ci-robot · 2023-12-19T18:49:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mickeyzzc, 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

pods support no node scraping

82f5679

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Oct 11, 2023

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 11, 2023

k8s-ci-robot requested review from dgrisonnet and logicalhan October 11, 2023 05:57

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. 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 Oct 11, 2023

add examples

f8b0cb7

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

mickeyzzc changed the title ~~Support scraping pods metrics that is still in scheduling status and has no assigned node~~ fix: Support scraping pods metrics that is still in scheduling status and has no assigned node Oct 11, 2023

CatherineF-dev reviewed Oct 11, 2023

View reviewed changes

examples/daemonsetsharding/deployment-no-node-pods.yaml Outdated Show resolved Hide resolved

k8s-ci-robot assigned CatherineF-dev Oct 11, 2023

mickeyzzc requested a review from CatherineF-dev October 11, 2023 14:34

simplified configuration

539f57d

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 12, 2023

mrueg reviewed Oct 12, 2023

View reviewed changes

examples/daemonsetsharding/deployment-no-node-pods.yaml Show resolved Hide resolved

mickeyzzc requested a review from mrueg October 12, 2023 15:02

CatherineF-dev reviewed Oct 12, 2023

View reviewed changes

examples/daemonsetsharding/deployment-no-node-pods.yaml Outdated Show resolved Hide resolved

CatherineF-dev reviewed Oct 12, 2023

View reviewed changes

pkg/options/options.go Outdated Show resolved Hide resolved

CatherineF-dev reviewed Oct 12, 2023

View reviewed changes

pkg/options/types.go Show resolved Hide resolved

CatherineF-dev reviewed Oct 12, 2023

View reviewed changes

pkg/options/types_test.go Show resolved Hide resolved

examples generated from libsonnet

d33929e

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

mickeyzzc force-pushed the pods-shards-support-no-node-scraping branch from dff7885 to d33929e Compare October 12, 2023 15:21

add test

5fc87fa

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

mickeyzzc requested a review from CatherineF-dev October 12, 2023 16:10

CatherineF-dev reviewed Oct 14, 2023

View reviewed changes

examples/daemonsetsharding/deployment-no-node-pods.yaml Show resolved Hide resolved

globals rename pods

f7ca990

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

mickeyzzc requested a review from CatherineF-dev October 18, 2023 06:05

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 19, 2023

Add code comments

d1f04c2

Signed-off-by: 蓝宝石的傻话 <mickey_zzc@163.com>

update readme ,track metrics for unassigned pods

ad0e06c

Signed-off-by: mickeyzzc <mickey_zzc@163.com>

mrueg reviewed Dec 18, 2023

View reviewed changes

mrueg reviewed Dec 19, 2023

View reviewed changes

README.md Show resolved Hide resolved

fix: Update README.md

37ceaf4

k8s-ci-robot assigned mrueg Dec 19, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 19, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 19, 2023

k8s-ci-robot merged commit 7324ae5 into kubernetes:main Dec 19, 2023
12 checks passed

diranged mentioned this pull request Apr 17, 2024

Node selection for fully qualified node-names fails (--node=ip-xx-xx-xx-xx.myzone.com) #2374

Open

dgrisonnet mentioned this pull request Apr 19, 2024

fix: . is removed in nodeName #2373

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Support scraping pods metrics that is still in scheduling status and has no assigned node #2217

fix: Support scraping pods metrics that is still in scheduling status and has no assigned node #2217

mickeyzzc commented Oct 11, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 11, 2023 •

edited

Loading

k8s-ci-robot commented Oct 11, 2023

CatherineF-dev commented Oct 11, 2023 •

edited

Loading

CatherineF-dev commented Oct 11, 2023

CatherineF-dev Oct 12, 2023 •

edited

Loading

CatherineF-dev Oct 12, 2023

mickeyzzc Oct 12, 2023

CatherineF-dev Oct 14, 2023

CatherineF-dev Nov 21, 2023 •

edited

Loading

mrueg Nov 24, 2023

CatherineF-dev commented Oct 12, 2023

dashpole commented Oct 19, 2023

mickeyzzc commented Nov 17, 2023

dashpole commented Nov 17, 2023

k8s-ci-robot commented Nov 21, 2023

mickeyzzc commented Nov 21, 2023

mrueg commented Nov 22, 2023

CatherineF-dev commented Nov 22, 2023 •

edited

Loading

CatherineF-dev commented Nov 22, 2023 •

edited

Loading

mickeyzzc commented Nov 23, 2023

mrueg Dec 18, 2023

mrueg commented Dec 19, 2023

k8s-ci-robot commented Dec 19, 2023

fix: Support scraping pods metrics that is still in scheduling status and has no assigned node #2217

fix: Support scraping pods metrics that is still in scheduling status and has no assigned node #2217

Conversation

mickeyzzc commented Oct 11, 2023 • edited Loading

linux-foundation-easycla bot commented Oct 11, 2023 • edited Loading

k8s-ci-robot commented Oct 11, 2023

CatherineF-dev commented Oct 11, 2023 • edited Loading

CatherineF-dev commented Oct 11, 2023

CatherineF-dev Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

CatherineF-dev Oct 12, 2023

Choose a reason for hiding this comment

mickeyzzc Oct 12, 2023

Choose a reason for hiding this comment

CatherineF-dev Oct 14, 2023

Choose a reason for hiding this comment

CatherineF-dev Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

mrueg Nov 24, 2023

Choose a reason for hiding this comment

CatherineF-dev commented Oct 12, 2023

dashpole commented Oct 19, 2023

mickeyzzc commented Nov 17, 2023

dashpole commented Nov 17, 2023

k8s-ci-robot commented Nov 21, 2023

mickeyzzc commented Nov 21, 2023

mrueg commented Nov 22, 2023

CatherineF-dev commented Nov 22, 2023 • edited Loading

CatherineF-dev commented Nov 22, 2023 • edited Loading

mickeyzzc commented Nov 23, 2023

mrueg Dec 18, 2023

Choose a reason for hiding this comment

mrueg commented Dec 19, 2023

k8s-ci-robot commented Dec 19, 2023

mickeyzzc commented Oct 11, 2023 •

edited

Loading

linux-foundation-easycla bot commented Oct 11, 2023 •

edited

Loading

CatherineF-dev commented Oct 11, 2023 •

edited

Loading

CatherineF-dev Oct 12, 2023 •

edited

Loading

CatherineF-dev Nov 21, 2023 •

edited

Loading

CatherineF-dev commented Nov 22, 2023 •

edited

Loading

CatherineF-dev commented Nov 22, 2023 •

edited

Loading