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

Metric cardinality enforcement #99385

Merged
merged 2 commits into from Mar 3, 2021
Merged

Metric cardinality enforcement #99385

merged 2 commits into from Mar 3, 2021

Conversation

YoyinZyc
Copy link
Contributor

@YoyinZyc YoyinZyc commented Feb 24, 2021 •
edited

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR added the ability the config metric label allowlist from CLI flag.

  1. add allow-label-value flag to get the allowlist input
  2. enable cardinality enforcement on counter metric.

Which issue(s) this PR fixes:

Fixes #76302

Special notes for your reviewer:

Does this PR introduce a user-facing change?

component owner can configure the allowlist of metric label with flag '--allow-metric-labels'.

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

- [KEP]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2305-metrics-cardinality-enforcement
- [Usage]: --allow-metric-labels metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. 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. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/apiserver area/dependency Issues or PRs related to dependency changes labels Feb 24, 2021
@k8s-ci-robot k8s-ci-robot requested review from andyxning, dixudx and a team February 24, 2021 00:28
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Feb 24, 2021
@YoyinZyc
Copy link
Contributor Author

/assign @logicalhan

@ehashman
Copy link
Member

/triage accepted
/priority important-soon

@YoyinZyc can you please fix the release note? It should start with ```release-note

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 24, 2021
@YoyinZyc
Copy link
Contributor Author

/retest

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 25, 2021
@k8s-ci-robot k8s-ci-robot added area/cloudprovider and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Feb 25, 2021
@k8s-ci-robot k8s-ci-robot added area/kubectl area/release-eng Issues or PRs related to the Release Engineering subproject sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/release Categorizes an issue or PR as relevant to SIG Release. labels Feb 28, 2021
@YoyinZyc YoyinZyc force-pushed the unbounded_metric branch 2 times, most recently from 0241d3f to eb2b079 Compare March 1, 2021 18:35
@YoyinZyc YoyinZyc mentioned this pull request Mar 2, 2021
Open
8 tasks
@YoyinZyc
Copy link
Contributor Author

YoyinZyc commented Mar 2, 2021

/retest

1 similar comment
@YoyinZyc
Copy link
Contributor Author

YoyinZyc commented Mar 2, 2021

/retest

logicalhan
logicalhan reviewed Mar 2, 2021
View reviewed changes
staging/src/k8s.io/component-base/metrics/opts.go Outdated
labelToAllowList map[string]sets.String
}

func (allowList *MetricLabelAllowList) Verify(labelNameList, labelValueList []string) {
Copy link
Member

Choose a reason for hiding this comment

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

nit: I prefer ConstrainToAllowedList over Verify

Copy link
Member

Choose a reason for hiding this comment

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

Mostly because verify functions are generally pass/fail, while this method mutates.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make sense. Changed.

staging/src/k8s.io/component-base/metrics/opts.go Outdated
}
}

func (allowList *MetricLabelAllowList) VerifyLabelMap(labels map[string]string) {
Copy link
Member

Choose a reason for hiding this comment

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

ConstainLabelMap

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed

staging/src/k8s.io/component-base/metrics/options.go Outdated
"The map from metric-label to value allow-list of this label. The key's format is <MetricName>,<LabelName>. "+
"The value's format is <allowed_value>,<allowed_value>..."+
"e.g. metric1,label1='v1,v2,v3', metric1,label2='v1,v2,v3' metric2,label1='v1,v2,v3'. "+
"(In use when MetricCardinalityEnforcement feature gate is enabled.)")
Copy link
Member

Choose a reason for hiding this comment

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

this should be removed?

Copy link
Member

Choose a reason for hiding this comment

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

just the last line

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I should. Thank you!

logicalhan
logicalhan approved these changes Mar 3, 2021
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 Mar 3, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: logicalhan, YoyinZyc

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 Mar 3, 2021
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Mar 3, 2021 •
edited

@YoyinZyc: The following tests failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-publishing-bot-validate 4c55831c7be46412496e56cbdbbf8b6a0482b026 link /test pull-publishing-bot-validate
pull-kubernetes-bazel-build 0241d3f092d3ae25510aae0b0afe6a718ddab7a9 link /test pull-kubernetes-bazel-build
pull-kubernetes-bazel-test 0241d3f092d3ae25510aae0b0afe6a718ddab7a9 link /test pull-kubernetes-bazel-test

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

@fejta-bot
Copy link

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

@k8s-ci-robot k8s-ci-robot merged commit b7d146b into kubernetes:master Mar 3, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Mar 3, 2021
@YoyinZyc YoyinZyc mentioned this pull request Mar 3, 2021
Merged
@YoyinZyc YoyinZyc mentioned this pull request Mar 15, 2021
Merged
@maxsmythe maxsmythe mentioned this pull request Jan 26, 2023
Merged
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

@andyxning andyxning Awaiting requested review from andyxning

@dixudx dixudx Awaiting requested review from dixudx

Assignees

@logicalhan logicalhan

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/apiserver area/cloudprovider area/dependency Issues or PRs related to dependency changes area/kubectl area/release-eng Issues or PRs related to the Release Engineering subproject 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. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.21
Development

Successfully merging this pull request may close these issues.

Unbounded valuesets for metric labels
5 participants
@YoyinZyc @ehashman @k8s-ci-robot @fejta-bot @logicalhan