📖 Improve help text for retries counter in workqueue#3477
Conversation
Updated help text for the retries counter to provide more clarity on its current scope.
|
|
|
Welcome @viveksb007! |
|
Hi @viveksb007. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
LGTM label has been added. DetailsGit tree hash: 6347a1df4b29f37606728945a73b26fe44aec454 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman, viveksb007 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| Subsystem: WorkQueueSubsystem, | ||
| Name: RetriesKey, | ||
| Help: "Total number of retries handled by workqueue", | ||
| Help: "Total number of items added to the workqueue with a non-zero delay (rate-limited requeues, explicit RequeueAfter or AddAfter calls)", |
There was a problem hiding this comment.
For me this is a bit of a confusing mixture between Reconciler and Queue wording.
Is this help text accurate both for PriorityQueue and the default queue that is used when PQ is not enabled?
For PriorityQueue the metric is incremented when AddAfter, AddRateLimitied or AddWithOpts (depends on opts) is called
Updated help text for the retries counter to provide more clarity on its current scope.
related slack thread in #sig-api-machinery https://kubernetes.slack.com/archives/C0EG7JC6T/p1772834493390239
this retry metric is getting incremented for cases where its not a true retry but queue additions with some delay. since changing metric name is a breaking change. thus improved the
Helpto inform future reader about the scope of this metric.ex usage