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.20
  • Beta release target (x.y): 1.28
  • Stable release target (x.y):
• Alpha
  • KEP (k/enhancements) update PR(s):
  • Code (k/k) update PR(s):
  • Docs (k/website) update PR(s):
• Beta
  • KEP (k/enhancements) update PR(s): KEP-2305: Metric cardinality enforcement #4039
  • Code (k/k) update PR(s): KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299
  • 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.

[rexagod]

Hello, @Kasambx! Thanks for pointing that out.

• I've documented test plan to the best of my knowledge for this KEP, but if there something you think is absent, please feel to let me know and I'll get that in!
• Done.
• I currently do not have permissions to edit this issue description, but I'm dropping the relevant (open) PRs below that drive the beta effort:
  • KEP-2305: Metric cardinality enforcement #4039
  • KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299

[Atharva-Shinde]

Thanks @rexagod :)
With all the KEP requirements in place and merged into k/enhancements, this enhancement is all good for the upcoming enhancements freeze 🚀.
The status of this enhancement is marked as tracked. Please keep the issue description up-to-date with appropriate stages as well.

[taniaduggal]

Hello @ehashman ! 1.28 Docs Shadow here.

Does this enhancement work planned for 1.28 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.28 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 20th July 2023.

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

Thank you!

[Rishit-dagli]

Hey @ehashman , could you please create a docs PR even if it is a draft PR with no content yet against dev-1.28 branch in the k/website repo. The deadline to create this draft PR is Thursday 20th July 2023.

[rexagod]

Created a placeholder here: kubernetes/website#41998. 🙂

[Atharva-Shinde]

Hey @rexagod Enhancements team here 👋

Just checking in as we approach Code freeze at 01:00 UTC Wednesday, 19th July 2023 .

Here’s the enhancement’s state for the upcoming code freeze:

• All the PRs that are related to your enhancement are linked in the above issue description (for tracking purposes). This includes code, tests, and documentation related PR/s.
• All code related PR/s are merged or are in merge-ready state ( i.e they have approved and lgtm labels applied) by the code freeze deadline. This includes any tests related PR/s too.

For this enhancement, it looks like the following code related PR is open and it needs to be merged or should be in merge-ready state before the code freeze commences :

• KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299

This is the code related PR that I found on this KEP issue

• KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299

Please keep the issue description up-to-date with all the PR/s that are associated with this KEP and let me know if there are other PR/s in k/k we should be tracking for this KEP.

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

[Atharva-Shinde]

Hello @rexagod 👋, 1.28 Enhancements Lead here.

Unfortunately, the implementation (code related) PR associated with this enhancement is not in the merge-ready state by code-freeze and hence this enhancement is now removed from the v1.28 milestone.

If you still wish to progress this enhancement in v1.28, please file an exception request. Thanks!

/milestone clear

[Atharva-Shinde]

As the exception request was approved, I'm adding this KEP back to the v1.28 milestone.

/milestone v1.28

[Rishit-dagli]

Hello @ehashman wave: please take a look at Documenting for a release - PR Ready for Review to get your docs PR ready for review before Tuesday 25th July 2023. Thank you!

Ref: kubernetes/website#41998

[Atharva-Shinde]

/milestone clear

[npolshakova]

Hello @ehashman, 1.29 Enhancements team here! Is this enhancement targeting 1.29? If it is, can you follow the instructions here to opt in the enhancement and make sure the lead-opted-in label is set so it can get added to the tracking board? Thanks!

[sanchita-07]

Hello @ehashman @logicalhan @YoyinZyc 👋, 1.29 Enhancements team here!

Just checking in as we approach enhancements freeze on 01:00 UTC, Friday, 6th October, 2023.

This enhancement is targeting for stage beta for 1.29 (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.29. 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 just need to mark the KEP status as implementable for latest-milestone: 1.29.

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.

Thank you!

[sanchita-07]

Hi @ehashman @logicalhan @YoyinZyc, checking in once more as we approach the 1.29 enhancement freeze deadline on 01:00 UTC, Friday, 6th October, 2023. The status of this enhancement is marked as at risk for enhancement freeze. It looks like changing the milestone and lastest-milestone to 1.29 will meet the requirements. Let me know if I missed anything. Thanks!

[rexagod]

Hello @sanchita-07, I've opened a PR to update the milestone to v1.29: #4268. Cheers!

[sanchita-07]

Thanks @rexagod :)
With all the KEP requirements in place and merged into k/enhancements, this enhancement is all good for the upcoming enhancements freeze 🚀.
The status of this enhancement is marked as tracked for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

[rexagod]

JFYI I cannot edit the issue description, but I'll post any updates here.

[Princesso]

Hey there @logicalhan, @YoyinZyc and @rexagod ! 👋, v1.29 Docs team shadow here.
Does this enhancement work planned for v1.29 require any new docs or modifications to existing docs?
If so, please follow the steps here to open a PR against dev-1.29 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, 19 October 2023.
Also, take a look at Documenting for a release to get yourself familiarized with the docs requirement for the release.
Thank you!

[rexagod]

ACK, updated the older PR to target dev-1.29: kubernetes/website#41998 (comment). :)

[kcmartin]

Hi @logicalhan, @YoyinZyc and @rexagod! 👋 from the v1.29 Release Team-Communications! We would like to check if you have any plans to publish a blog for this KEP regarding new features, removals, and deprecations for this release.

If so, you need to open a PR placeholder in the website repository.
The deadline will be on Tuesday 14th November 2023 (after the Docs deadline PR ready for review)

Here's the 1.29 Calendar

[sanchita-07]

Hey again @logicalhan @YoyinZyc @rexagod again 👋, 1.29 Enhancements team here.

Just checking in as we approach code freeze at 01:00 UTC Wednesday 1st November 2023:

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, it looks like the following PR was merged before code freeze:

• KEP-2305: introduce allow-metric-labels-manifest kubernetes#118299

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.

With the merged and linked in the issue description, this KEP is tracked for code freeze for v1.29. 🚀
As always, we are here to help if any questions come up ✌. Thanks :)

[sftim]

The enforcement is quite hard to teach - see kubernetes/website#41998 (comment) - mostly because we use the term “manifest” in an associated command line argument. Kubernetes already has a well-used, different meaning for that term.

If it's feasible to fix that use, I think we should. We could continue to support the existing command line argument for many releases, deprecating it rather than removing it.

(I know this KEP has already been reviewed and is proposed for graduatation to beta, but I don't think it was previously documented - this first opportunity to look at the way we explain it to end users has highlighted what I see as a gap).