fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests #8225

ekovacs · 2022-02-05T23:54:53Z

What this PR does / why we need it:

it fixes a bug:

described in issue: inconsistent label cardinality on nginx_ingress_controller_requests prometheus metrics #8224
introduced by PR: feat(metrics): add path and method labels to requests counter #8201

the bug prevents the collection of metrics: nginx_ingress_controller_requests

#8224

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation only

Which issue/s this PR fixes

fixes #8224

How Has This Been Tested?

added unit test which failed without this fix, and passes with this fix in place.

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have added tests to cover my changes.
All new and existing tests passed.

ekovacs · 2022-02-05T23:58:12Z

internal/ingress/metric/collectors/socket.go

+			if c, ok := metric.(*prometheus.CounterVec); ok {
+				if removed := c.Delete(labels); !removed {
+					klog.V(2).InfoS("metric not removed", "name", metricName, "ingress", ingKey, "labels", labels)
+				}
+			}


additionally during unit-testing, i also discovered that nginx_ingress_controller_requests would not get removed/deleted in the unit-test (by the call of sc.RemoveMetrics(...)) due to prometheus.CounterVec was missing from here.

ekovacs · 2022-02-05T23:59:20Z

internal/ingress/metric/collectors/socket.go

+			"host":      stats.Host,
+			"method":    stats.Method,
+			"path":      stats.Path,


these were the missing labels that caused the inconsistent label cardinality

ekovacs · 2022-02-06T00:00:47Z

internal/ingress/metric/collectors/socket.go

@@ -217,6 +217,7 @@ func NewSocketCollector(pod, namespace, class string, metricsPerHost bool, bucke
 	}

 	sc.metricMapping = map[string]interface{}{
+		prometheus.BuildFQName(PrometheusNamespace, "", "requests"):                 sc.requests,


additionally during unit-testing, i also discovered that requests was missing from here (this was the only one metric that was missing the mapping).

for prometheus metrics: nginx_ingress_controller_requests

k8s-ci-robot · 2022-02-06T00:20:08Z

@ekovacs: This issue is currently awaiting triage.

If Ingress contributors 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 · 2022-02-06T00:20:09Z

Welcome @ekovacs!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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/ingress-nginx 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 · 2022-02-06T00:20:09Z

Hi @ekovacs. 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.

linux-foundation-easycla · 2022-02-06T00:36:58Z

The committers are authorized under a signed CLA.

✅ Endre Kovács (9c6944e)

ekovacs · 2022-02-06T08:13:14Z

/check-cla

ekovacs · 2022-02-06T15:27:35Z

/assign @ElvinEfendi

ekovacs · 2022-02-08T10:06:44Z

/assign @rikatz

rikatz · 2022-02-08T23:38:59Z

/ok-to-test

rikatz · 2022-02-13T18:27:47Z

good catch @ekovacs
/lgtm
/approve
Thanks

k8s-ci-robot · 2022-02-13T18:28:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ekovacs, rikatz

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~~ [rikatz]

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

…ess_controller_requests (kubernetes#8225) * fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests * add host to collectorLabels only if metricsPerHost is true

ekovacs commented Feb 5, 2022

View reviewed changes

ekovacs commented Feb 6, 2022

View reviewed changes

fix inconsistent-label-cardinality

9c6944e

for prometheus metrics: nginx_ingress_controller_requests

ekovacs force-pushed the fix/inconsisten-label-cardinality branch from fb6b142 to 9c6944e Compare February 6, 2022 00:17

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

k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 6, 2022

k8s-ci-robot requested review from ElvinEfendi and rikatz February 6, 2022 00:20

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 6, 2022

k8s-ci-robot assigned ElvinEfendi Feb 6, 2022

add host to collectorLabels only if metricsPerHost is true

80fcbcf

k8s-ci-robot assigned rikatz Feb 8, 2022

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 Feb 8, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 13, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 13, 2022

k8s-ci-robot merged commit 86964b1 into kubernetes:main Feb 13, 2022

ekovacs deleted the fix/inconsisten-label-cardinality branch February 14, 2022 12:02

tao12345666333 mentioned this pull request Feb 27, 2022

v1.1.2 Release #8274

Closed

longwuyuan mentioned this pull request Jul 4, 2022

My Ingress nginx metrics lost some metrics，for example nginx_ingress_controller_requests #8782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests #8225

fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests #8225

ekovacs commented Feb 5, 2022

ekovacs Feb 5, 2022

ekovacs Feb 5, 2022

ekovacs Feb 6, 2022 •

edited

Loading

k8s-ci-robot commented Feb 6, 2022

k8s-ci-robot commented Feb 6, 2022

k8s-ci-robot commented Feb 6, 2022

linux-foundation-easycla bot commented Feb 6, 2022 •

edited

Loading

ekovacs commented Feb 6, 2022

ekovacs commented Feb 6, 2022

ekovacs commented Feb 8, 2022

rikatz commented Feb 8, 2022

rikatz commented Feb 13, 2022

k8s-ci-robot commented Feb 13, 2022

fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests #8225

fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests #8225

Conversation

ekovacs commented Feb 5, 2022

What this PR does / why we need it:

Types of changes

Which issue/s this PR fixes

How Has This Been Tested?

Checklist:

ekovacs Feb 5, 2022

Choose a reason for hiding this comment

ekovacs Feb 5, 2022

Choose a reason for hiding this comment

ekovacs Feb 6, 2022 • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 6, 2022

k8s-ci-robot commented Feb 6, 2022

k8s-ci-robot commented Feb 6, 2022

linux-foundation-easycla bot commented Feb 6, 2022 • edited Loading

ekovacs commented Feb 6, 2022

ekovacs commented Feb 6, 2022

ekovacs commented Feb 8, 2022

rikatz commented Feb 8, 2022

rikatz commented Feb 13, 2022

k8s-ci-robot commented Feb 13, 2022

ekovacs Feb 6, 2022 •

edited

Loading

linux-foundation-easycla bot commented Feb 6, 2022 •

edited

Loading