github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-27 05:27:21 +00:00
Code Issues Projects Releases Wiki Activity

Document when workqueue metrics are dropped

Browse Source 
Two simple choices for workqueues do not document that they do not emit
metrics. Using their named variants fixes this, but was undocumented.

Change-Id: I100ad08a4859513987941ed35d12abb4cbb39873
This commit is contained in:
Spencer Peterson 2021-12-09 16:59:54 -08:00
parent 481459d12d
commit f468bee672
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
staging/src/k8s.io/client-go/util/workqueue/delaying_queue.go
View File

@ -33,7 +33,9 @@ type DelayingInterface interface {
AddAfter(item interface{}, duration time.Duration) AddAfter(item interface{}, duration time.Duration)
} }
// NewDelayingQueue constructs a new workqueue with delayed queuing ability // NewDelayingQueue constructs a new workqueue with delayed queuing ability.
// NewDelayingQueue does not emit metrics. For use with a MetricsProvider, please use
// NewNamedDelayingQueue instead.
func NewDelayingQueue() DelayingInterface { func NewDelayingQueue() DelayingInterface {
return NewDelayingQueueWithCustomClock(clock.RealClock{}, "") return NewDelayingQueueWithCustomClock(clock.RealClock{}, "")
} }

2
staging/src/k8s.io/client-go/util/workqueue/rate_limiting_queue.go
View File

@ -34,6 +34,8 @@ type RateLimitingInterface interface {
// NewRateLimitingQueue constructs a new workqueue with rateLimited queuing ability // NewRateLimitingQueue constructs a new workqueue with rateLimited queuing ability
// Remember to call Forget! If you don't, you may end up tracking failures forever. // Remember to call Forget! If you don't, you may end up tracking failures forever.
// NewRateLimitingQueue does not emit metrics. For use with a MetricsProvider, please use
// NewNamedRateLimitingQueue instead.
func NewRateLimitingQueue(rateLimiter RateLimiter) RateLimitingInterface { func NewRateLimitingQueue(rateLimiter RateLimiter) RateLimitingInterface {
return &rateLimitingType{ return &rateLimitingType{
DelayingInterface: NewDelayingQueue(), DelayingInterface: NewDelayingQueue(),