feat: add kube_ingress_status metric #2433

isuyyy · 2024-06-26T14:05:13Z

What this PR does / why we need it:
Collects metrics of ingress status. / The info is needed when we use ALB.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
Increases.

Which issue(s) this PR fixes:
Fixes #1366

linux-foundation-easycla · 2024-06-26T14:05:17Z

The committers listed above are authorized under a signed CLA.

✅ login: isuyyy (348585d, c88e383, 622505e)

dgrisonnet · 2024-06-27T16:46:51Z

/triage accepted
/assign @richabanker

richabanker · 2024-07-02T17:44:52Z

internal/store/ingress.go

+			"kube_ingress_status",
+			"Ingress status.",
+			metric.Gauge,
+			basemetrics.STABLE,


Perhaps should start with an EXPERIMENTAL metric https://github.com/kubernetes/kube-state-metrics/blob/main/docs/developer/guide.md#add-new-metrics ?
cc @CatherineF-dev

Fixed here c88e383

richabanker · 2024-07-02T17:46:04Z

internal/store/ingress.go

+				for _, ingress := range i.Status.LoadBalancer.Ingress {
+					for _, port := range ingress.Ports {
+						ms = append(ms, &metric.Metric{
+							LabelKeys:   []string{"ip", "hostname", "port", "protocol"},


Do you need both the ip & the hostname ?

Wondering since IPs can keep on changing so cardinality might explode. Just using hostname might suffice?

At first, I just wanted to include all the fields, but as you mentioned, the hostname will suffice.
Made the changes here: 622505e

If we're removing IPs could we end up with duplicate metrics if multiple LB VIPs serve the same hostname (not sure if this is likely at all, maybe with multiple regionally deployed LBs)?

I don't think we should include IPs (due to the cardinality concern that Richa pointed out).

If we're removing IPs could we end up with duplicate metrics if multiple LB VIPs serve the same hostname (not sure if this is likely at all, maybe with multiple regionally deployed LBs)?

Won't we have unique instance IDs?

With instance IDs you mean in this object https://pkg.go.dev/k8s.io/api/networking/v1#Ingress ?

I don't know if that is the case, I assume there's must be some reason why the object is so convoluted...

https://pkg.go.dev/k8s.io/api/networking/v1#IngressLoadBalancerStatus contains a list of https://pkg.go.dev/k8s.io/api/networking/v1#IngressLoadBalancerIngress (both IP and Hostname are optional, without having looked into the code, I assume you need to set either one or the other?)
which then contains a list of https://pkg.go.dev/k8s.io/api/networking/v1#IngressPortStatus

I think we should keep both ip and hostname otherwise this metric won't make much sense since we won't be able to distinguish between the load balancers.
If cardinality is a concern we can always have this metric disabled by default, but here I don't think it is a problem because the number of timeseries for this metric will be limited to the number of Endpoints in the cluster. This is just the theoretical worst case scenario, but in practice it will only be a subset of that since it only includes the endpoints of the loadbalancer. and since the number of Endpoints in a cluster is limited due to scalability limits, this metric will be bounded.

Disclaimer: I am not too knowledgeable about Ingress so for what I know it might just be bounded to the number of Services instead of Endpoints which is even better. It all depends on where the <ip/hostname>: pair come from.

richabanker · 2024-07-09T18:37:07Z

/lgtm

k8s-ci-robot · 2024-07-09T18:37:14Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: isuyyy, richabanker
Once this PR has been reviewed and has the lgtm label, please assign dgrisonnet for approval. For more information see the Kubernetes Code Review Process.

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

richabanker · 2024-07-09T18:37:41Z

/assign @dgrisonnet
for approval

mrueg · 2024-07-15T17:43:02Z

internal/store/ingress.go

@@ -202,6 +202,28 @@ func ingressMetricFamilies(allowAnnotationsList, allowLabelsList []string) []gen
 				}
 			}),
 		),
+		*generator.NewFamilyGeneratorWithStability(
+			"kube_ingress_status",


Suggested change

"kube_ingress_status",

"kube_ingress_status",

I'm a bit torn on this name.
Maybe:
kube_ingress_status_loadbalancer (just wondering if additional fields get added to _status this might be difficult to include)

mrueg · 2024-07-15T17:44:35Z

internal/store/ingress_test.go

+									{
+										Port:     8888,
+										Protocol: "TCP",
+										Error:    nil,


Should we expose this error somehow as well?

I assume it can potentially cause high cardinality, but it will be interesting to know if there's an error on the IngressPortStatus?

k8s-triage-robot · 2024-10-17T20:11:52Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle stale

k8s-triage-robot · 2024-11-16T20:18:46Z

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

This bot triages 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 PR is closed

You can:

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

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

/lifecycle rotten

feat: add kube_ingress_status metric

348585d

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 26, 2024

k8s-ci-robot requested review from dgrisonnet and mrueg June 26, 2024 14:05

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 Jun 26, 2024

k8s-ci-robot assigned richabanker Jun 27, 2024

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 Jun 27, 2024

richabanker reviewed Jul 2, 2024

View reviewed changes

isuyyy added 2 commits July 5, 2024 11:25

Change metric stability level to EXPERIMENTAL

c88e383

Remove the ip field

622505e

isuyyy requested a review from richabanker July 5, 2024 04:50

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 9, 2024

k8s-ci-robot assigned dgrisonnet Jul 9, 2024

mrueg reviewed Jul 15, 2024

View reviewed changes

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

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 Nov 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add kube_ingress_status metric #2433

feat: add kube_ingress_status metric #2433

isuyyy commented Jun 26, 2024

linux-foundation-easycla bot commented Jun 26, 2024 •

edited

Loading

dgrisonnet commented Jun 27, 2024

richabanker Jul 2, 2024

isuyyy Jul 5, 2024

richabanker Jul 2, 2024

richabanker Jul 2, 2024

isuyyy Jul 5, 2024

mrueg Jul 15, 2024

logicalhan Jul 15, 2024

mrueg Jul 15, 2024

dgrisonnet Jul 19, 2024

richabanker commented Jul 9, 2024

k8s-ci-robot commented Jul 9, 2024

richabanker commented Jul 9, 2024

mrueg Jul 15, 2024 •

edited

Loading

mrueg Jul 15, 2024

k8s-triage-robot commented Oct 17, 2024

k8s-triage-robot commented Nov 16, 2024

feat: add kube_ingress_status metric #2433

Are you sure you want to change the base?

feat: add kube_ingress_status metric #2433

Conversation

isuyyy commented Jun 26, 2024

linux-foundation-easycla bot commented Jun 26, 2024 • edited Loading

dgrisonnet commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richabanker commented Jul 9, 2024

k8s-ci-robot commented Jul 9, 2024

richabanker commented Jul 9, 2024

mrueg Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-triage-robot commented Oct 17, 2024

k8s-triage-robot commented Nov 16, 2024

linux-foundation-easycla bot commented Jun 26, 2024 •

edited

Loading

mrueg Jul 15, 2024 •

edited

Loading