Metric cardinality enforcement

[ehashman]

Enhancement Description

• One-line enhancement description (can be used as a release note): Dynamically configure allowlists for metric label values at runtime
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2305-metrics-cardinality-enforcement
• Discussion Link: https://github.com/kubernetes/community/blob/master/sig-instrumentation/archive/meeting-notes-2020.md#agenda-2020-04-02
• Primary contact (assignee): @logicalhan @YoyinZyc
• Responsible SIGs: /sig instrumentation
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.21
  • Beta release target (x.y): 1.28-1.29
  • Stable release target (x.y): 1.31
• Alpha
  • KEP (k/enhancements) update PR(s):
    • expand on GA requirements for metrics stability framework #2431
    • Update the metric cardinality kep #2468
  • Code (k/k) update PR(s):
    • Metric cardinality enforcement kubernetes#99385
  • Docs (k/website) update PR(s):
    • Update doc for metric cardinality and disabled metric website#27069
• Beta
  • KEP (k/enhancements) update PR(s):
    • 1.28 KEP-2305: Metric cardinality enforcement #4039
  • Code (k/k) update PR(s):
    • 1.29 KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299
  • Docs (k/website) update(s):
    • 1.29 Document dynamic cardinality enforcement (KEP 2305) website#41998
• Stable
  • KEP (k/enhancements) update PR(s):
    • 1.30 GA Metrics Cardinality Enforcement #4422
    • 1.30 Metrics Cardinality Enforcement - Update README  #4499
    • 1.31 Update latest-milestone for KEP-2305 #4695
  • Code (k/k) update PR(s):
  • Docs (k/website) update(s):

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[ehashman]

/sig instrumentation
/stage alpha

[lilic]

@ehashman is there any action items for either Han or me? Thank you!

[ehashman]

@lilic this KEP graduated to alpha last cycle (1.20), it would be good to finish up beta and graduation criteria and target releases for those.

[ehashman]

@lilic @logicalhan once we have beta/graduation criteria we should decide how we want to target milestones for this moving forward. That's all currently empty:

https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2305-metrics-cardinality-enforcement#post-beta-tasks

[ehashman]

/milestone v1.21

slipped from 1.20

[annajung]

Hi @logicalhan and @lilic, 1.21 Enhancements Lead here

For the enhancement to be included in the milestone, it must meet the following criteria:

• [DONE] The KEP must be merged in an implementable state
• The KEP must have test plans
• The KEP must have graduation criteria
• The KEP must have a production readiness review

Please make sure you update the KEP using the latest template.

Also starting 1.21, all KEP must include a production readiness review. Please make sure to take a look at the instructions and update the KEP to include this. For PRR review, please make sure to reach out to #prod-readiness slack channel asap to get this in before the enhancements freeze coming up on Feb. 9th.

Thank you!

[JamesLaverack]

Hey @logicalhan and @lilic, 1.21 enhancements shadow here,

Just to add to Anna's comment above — enhancement's freeze is 2 days away, Feb 9th EOD PST. Any enhancements that do not complete the requirements in Anna's comment above by the freeze will require an exception.

[ehashman]

I've pinged @logicalhan about getting this added today.

[YoyinZyc]

Opened #2468 to update kep and request for PPR approval.

[ehashman]

@annajung everything should now be addressed.

[annajung]

With PR #2468 merged, this enhancement meets all criteria required for the enhancements freeze 👍

[alculquicondor]

ref kubernetes/kubernetes#97208

I have a couple of suggestions for extensions:

• Can we generalize the proposal to allow for mapping? That is, instead of replacing the value with "unknown", allowing configurable renaming, maybe with numeric intervals or regex.
• Make this configurable via component configs, as a CLI arg would be harder to maintain.

[JamesLaverack]

Hi @logicalhan and @lilic,

Since your Enhancement is scheduled to be in 1.21, please keep in mind the important upcoming dates:

• Tuesday, March 9th: Week 9 — Code Freeze
• Tuesday, March 16th: Week 10 — Docs Placeholder PR deadline
  • If this enhancement requires new docs or modification to existing docs, please follow the steps in the Open a placeholder PR doc to open a PR against k/website repo.

As a reminder, please link all of your k/k PR(s) and k/website PR(s) to this issue so we can track them.

Thanks!

[JamesLaverack]

Hi @logicalhan and @lilic,

Enhancements team is marking this enhancement as "At Risk" for the upcoming code freeze due to not seeing any linked k/k PR(s) for this enhancement.

Please make sure to provide all k/k PR(s) and k/website PR(s) to this issue so it can be tracked by the release team.

[ehashman]

@JamesLaverack I'm updating the point contacts to be @logicalhan and @YoyinZyc

[YoyinZyc]

@JamesLaverack There is one ongoing pr kubernetes/kubernetes#99385

[YoyinZyc]

ref kubernetes/kubernetes#97208

I have a couple of suggestions for extensions:

• Can we generalize the proposal to allow for mapping? That is, instead of replacing the value with "unknown", allowing configurable renaming, maybe with numeric intervals or regex.
• Make this configurable via component configs, as a CLI arg would be harder to maintain.

I think they are good ideas. I'll keep that in mind. Thanks!

[JamesLaverack]

@ehashman Thanks for the clarification! We'll update our tracking spreadsheet to reflect that.

@YoyinZyc Thank you for linking me, i've set this enhancement back to "Tracked". I see that kubernetes/kubernetes#99385 is now merged. Are there any other k/k pull requests outstanding (/need doing before code freeze) or can I mark you as done?

[YoyinZyc]

Yuchen Zhou Thank you for linking me, i've set this enhancement back to "Tracked". I see that kubernetes/kubernetes#99385 is now merged. Are there any other k/k pull requests outstanding (/need doing before code freeze) or can I mark you as done?

@JamesLaverack I have one more pr kubernetes/kubernetes#99738. Once it is merged, you can mark it as done.:)

[ehashman]

Code changes are complete, we just need to follow up with documentation updates.

[YoyinZyc]

Code changes are complete, we just need to follow up with documentation updates.

Can you give me some instruction on which document I should update? I am not sure I know all. Thanks!

[JamesLaverack]

Thanks both. I've now updated the enhancement tracking spreadsheet to note this enhancement as done for code freeze.

[sreeram-venkitesh]

/milestone v1.31

[tjons]

Hello @rexagod 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting for stage stable for 1.31 (correct me, if otherwise)

Here’s where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: { 1.31 }. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

For this KEP, we would just need to complete the following:

• Mark the KEP status as implementable for latest-milestone: { 1.31 }. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed. Your KEP status is currently marked as implementable for 1.30, but not 1.31.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[sreeram-venkitesh]

/stage stable

[salaxander]

Hello @rexagod 👋, 1.31 Docs Shadow here.

Does the work related to this KEP planned for 1.31 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 18:00 PDT.

Also, take a look at Documenting for a release to get yourself familiarised with the docs requirement for the release.

Thank you!

[sreeram-venkitesh]

With #4695 merged, we can mark this KEP as tracked for enhancements freeze 🎉

[a-mccarthy]

Hi @rexagod,

👋 from the v1.31 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[rexagod]

Hello, @a-mccarthy. The website PR was raised a while ago and merged: kubernetes/website#41998.

[a-mccarthy]

Hello, @a-mccarthy. The website PR was raised a while ago and merged: kubernetes/website#41998.

@rexagod thanks for sharing that PR, it looks like it was for docs content added for 1.29. Are there any new change for 1.31 that we should tell users about in a blog? This would be for any new changes or to give users an introduction to this feature, and would be published here blog, it is different than the docs content. We are checking again now that this is moving to stable in 1.31.

cc: @salaxander since we are also talking about docs :)

If there are any changes to the docs that are needed or if you would like to write a blog, you would need to create 2 separate placeholder PRs. One for docs updates and one for a blog.

[a-mccarthy]

@rexagod friendly reminder about the upcoming blog opt-in and placeholder deadline on July 3rd. Please open a blog placeholder PR if you are interested in contributing a blog.

[rexagod]

Sorry, I missed your previous comment. I think the website documentation should suffice for this one. :)

[tjons]

Hi @rexagod - 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 24th July 2024 / 19:00 PDT Tuesday 23rd July 2024 .

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, I wasn't able to find any new k/k PRs in the 1.31 release cycle after searching around. Are there any I should be tracking, or is all the work here taken care of?

As always, we are here to help if any questions come up. Thanks!

[rexagod]

@tjons All work here has been taken care of in previous releases. I don't have access to edit the description (yet). The latest-milestone for this has been bumped to v1.31.

[tjons]

Awesome @rexagod - this is now tracked for code freeze 🚀

[sreeram-venkitesh]

@rexagod Can you post the links to the PRs for graduating this KEP to stable stage as a comment in this thread? We want to understand what changes went into the v1.31 milestone.

[rexagod]

Sure thing!

Migration to stable: https://github.com/kubernetes/enhancements/pull/4422/files
Updating status to implemented and latest-milestone to v1.31: https://github.com/kubernetes/enhancements/pull/4695/files

[tjons]

@rexagod in preparation for the next release, now that this KEP has been implemented, would you kindly update the KEP status to implemented and then close this out?

[rexagod]

KEP status marked as implemented in c9213a9. I can't close an issue I'm not the author of (yet, see kubernetes/org#5096), so I'd be grateful if someone can do it for me, else I can do it once the PR is in.