client-go: Add metrics into informer

[chenk008]

Enhancement Description

• One-line enhancement description (can be used as a release note):
  Add metrics into informer.

• Kubernetes Enhancement Proposal: KEP-4346: client-go: Add informer metrics #4349

• Discussion Link: client-go: Add metrics into Informer kubernetes#122067

• Primary contact (assignee): @chenk008

• Responsible SIGs:
  sig/api-machinery

• Enhancement target (which target equals to which milestone):

  • Alpha release target (v1.30):
  • Beta release target (v1.31):
  • Stable release target (v1.33):

• Alpha

  • KEP (k/enhancements) update PR(s):
    • KEP-4346: client-go: Add informer metrics #4349 Initial KEP PR
    • Supplement for KEP-4346 #4504 Add missing push
    • KEP-4346: add PRR metadata file for 4346 #4511 Add PRR metadata file
  • Code (k/k) update PR(s):
    • Introduce reflector metrics with featuregate InformerMetrics kubernetes#123367
    • [WIP] Introduce informer fifo/handler metrics kubernetes#123510
  • Docs (k/website) update PR(s):
    • [WIP] [KEP-4346]: feature-gate InformerMetrics to alpha website#45273

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

[chenk008]

/sig api-machinery

[chenk008]

related issue:
kubernetes/client-go#1027
kubernetes-sigs/controller-runtime#817
kubernetes/kubernetes#121662
kubernetes/kubernetes#117123

[lzlaa]

It's useful to find out whether there are unhandled events received by reflector.

[fedebongio]

/assign @logicalhan

[jpbetz]

/label lead-opted-in
/milestone v1.30

[salehsedghpour]

Hello @logicalhan 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 9th February 2024.

This enhancement is targeting for stage alpha for v1.30 (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.30.
• 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 want to update the following but it's not required for alpha stage and it will serve for future stages:

• Make sure that the filled README.md file is merged to the k/enhancements repo. Moreover, all questions in the PRR questionnaire need to be answered.
• Make sure that the KEP status is marked as implementable and the latest-milestone is 1.30, while the reviewers and approvers are there.
• Make sure that there is graduation criteria at least for alpha stage.
• Make sure that there is a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here)

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, I couldn't find any related PR regarding this KEP in k/enhancements. Thank you!

[salehsedghpour]

Hello @logicalhan 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 9th February 2024. (In few hours) And I found the open PR #4349.

This enhancement is targeting for stage alpha for v1.30 (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.30.
• 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 want to update the following but it's not required for alpha stage and it will serve for future stages:

• Make sure that the filled README.md file is merged to the k/enhancements repo. Moreover, all questions in the PRR questionnaire need to be answered.
• Make sure that the KEP status is marked as implementable and the latest-milestone is 1.30, while the reviewers and approvers are there.
• Make sure that there is graduation criteria at least for alpha stage.
• Make sure that there is a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here)

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, I couldn't find any related PR regarding this KEP in k/enhancements. Thank you!

[salehsedghpour]

Hello 👋, v1.30 Enhancements team here.

Unfortunately, this enhancement did not meet requirements for enhancements freeze.

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

[salehsedghpour]

/milestone clear

[drewhagen]

Hello @chenk008 @logicalhan 👋, 1.30 Docs Lead here.

Does this enhancement work planned for 1.30 require any new docs or modification to existing docs?
If so, please follows the steps here to open a PR against dev-1.30 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday February 22nd 2024 18:00 PDT.

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

[Checksumz]

Hi @chenk008 ,

👋 from the v1.30 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!

We encourage blogs for features including, but not limited to: breaking changes, features and changes important to our users, and features that have been in progress for a long time and are graduating.

To opt in, you need to open a Feature Blog placeholder PR against the website repository.
The placeholder PR deadline is 27th February, 2024.
Here's the 1.30 Release Calendar

[salehsedghpour]

Hey again @logicalhan and @chenk008 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 6th March 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, it looks like the following PRs are open and need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP):

• Introduce reflector metrics with featuregate InformerMetrics kubernetes#123367

With this, it is now marked as at risk for code freeze for the v1.30 Code Freeze!

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[salehsedghpour]

Hello @logicalhan and @chenk008 👋 Enhancements team here,

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

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

/milestone clear

[sreeram-venkitesh]

Hi @logicalhan, @chenk008 👋, 1.31 Enhancements Lead here.

If you wish to progress this enhancement in v1.31, please have the SIG lead opt-in your enhancement by adding the lead-opted-in label and set the milestone to v1.31 before the Production Readiness Review Freeze.

/remove-label lead-opted-in

[chenk008]

@logicalhan Please confirm if this can be opted in?

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle stale

[k8s-triage-robot]

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle rotten

[k8s-triage-robot]

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

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

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

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

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

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

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

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

/close not-planned

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-sigs/prow repository.

[k8s-ci-robot]

@xigang: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to this:

/reopen

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-sigs/prow repository.

[xigang]

/sig api-machinery
/sig scalability

Hi all, adding monitoring metrics for RingGrowing pendingNotification for each eventHandler to track memory usage is very important. If the RingGrowing memory keeps increasing, it may lead to informer data latency issues. We should continue pushing this feature forward.

/cc @wojtek-t @aojea @liggitt @chenk008

[xigang]

/sig api-machinery /sig scalability

Hi all, adding monitoring metrics for RingGrowing pendingNotification for each eventHandler to track memory usage is very important. If the RingGrowing memory keeps increasing, it may lead to informer data latency issues. We should continue pushing this feature forward.

/cc @wojtek-t @aojea @liggitt @chenk008

new PR:kubernetes/kubernetes#129160