Skip to content
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

Jump to bottom

add metrics/slis to kube-proxy health checks #113057

Merged
merged 1 commit into from Oct 15, 2022
Merged

add metrics/slis to kube-proxy health checks #113057

merged 1 commit into from Oct 15, 2022

Conversation

richabanker
Copy link
Contributor

What type of PR is this?

/kind feature

What this PR does / why we need it:

Adds health check SLI metrics to kube-proxy. This is behind a feature gate.

Which issue(s) this PR fixes:

Fixes #112959

Special notes for your reviewer:

Does this PR introduce a user-facing change?

If `ComponentSLIs` feature gate is enabled, then `/metrics/slis` becomes available on kube-proxy allowing you to scrape health check metrics.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

- [KEP]: https://kep.k8s.io/3466

# HELP kubernetes_healthcheck [ALPHA] This metric records the result of a single healthcheck.
# TYPE kubernetes_healthcheck gauge
kubernetes_healthcheck{name="ping",type="healthz"} 1
# HELP kubernetes_healthchecks_total [ALPHA] This metric records the results of all healthcheck.
# TYPE kubernetes_healthchecks_total counter
kubernetes_healthchecks_total{name="ping",status="success",type="healthz"} 1

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 13, 2022
@k8s-ci-robot
Copy link
Contributor

@richabanker: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-ci-robot
Copy link
Contributor

Hi @richabanker. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. sig/network Categorizes an issue or PR as relevant to SIG Network. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 13, 2022
@aojea
Copy link
Member

aojea commented Oct 14, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 14, 2022
aojea
aojea reviewed Oct 14, 2022
View reviewed changes
cmd/kube-proxy/app/server.go
@@ -86,6 +88,10 @@ import (
"k8s.io/utils/pointer"
)

func init() {
utilruntime.Must(metricsfeatures.AddFeatureGates(utilfeature.DefaultMutableFeatureGate))
Copy link
Member

Choose a reason for hiding this comment

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

why is this needed?

Copy link
Member

Choose a reason for hiding this comment

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

You need to register the feature gates before flags are applied, so conventionally this is done through an init function.

Copy link
Member

@aojea aojea Oct 14, 2022 •
edited

Choose a reason for hiding this comment

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

are we not already setting them on line 247?

	return utilfeature.DefaultMutableFeatureGate.SetFromMap(o.config.FeatureGates)

Copy link
Member

Choose a reason for hiding this comment

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

We can probably also try setting it the line before. But the init function is pretty standard way of setting this across the kubernetes code base.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was able to curl the /metrics/slis endpoint after commenting out the init() block- so functionally, its ok to be removed, but it makes sense to keep the init() block and follow the conventional way for initialization purposes.

Copy link
Member

Choose a reason for hiding this comment

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

Your call @aojea 😃 we're open to either way, but I think we're slightly more inclined to follow convention.

Copy link
Member

Choose a reason for hiding this comment

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

yeah, me too, I just wanted to fully understand it
Thanks for clarifying

@aojea
Copy link
Member

aojea commented Oct 14, 2022

/assign @aojea @logicalhan

one naive question

logicalhan
logicalhan approved these changes Oct 14, 2022
View reviewed changes
Copy link
Member

@logicalhan logicalhan left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 14, 2022
@aojea
Copy link
Member

aojea commented Oct 15, 2022

/approve

clarified in #113057 (comment)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aojea, logicalhan, Richabanker

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 15, 2022
@aojea
Copy link
Member

aojea commented Oct 15, 2022

Trace[132957275]: [151.860425ms] [151.860425ms] END
panic: test timed out after 3m0s
goroutine 32339 [running]:
testing.(*M).startAlarm.func1()

/test pull-kubernetes-unit

@k8s-ci-robot k8s-ci-robot merged commit b6e8dfe into kubernetes:master Oct 15, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.26 milestone Oct 15, 2022
@richabanker richabanker mentioned this pull request Nov 1, 2022
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@logicalhan logicalhan logicalhan approved these changes

@aojea aojea aojea left review comments

@bowei bowei Awaiting requested review from bowei

@caseydavenport caseydavenport Awaiting requested review from caseydavenport

Assignees

@logicalhan logicalhan

@aojea aojea

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/network Categorizes an issue or PR as relevant to SIG Network. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
v1.26
Development

Successfully merging this pull request may close these issues.

Wire up metrics/slis for kube-proxy
4 participants
@richabanker @k8s-ci-robot @aojea @logicalhan