Document when workqueue metrics are dropped

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

Kubernetes-commit: f468bee672b0ccf9b97a85f17ec1f5645aced926
This commit is contained in:
Spencer Peterson
2021-12-09 16:59:54 -08:00
committed by Kubernetes Publisher
parent 056a9de353
commit 5a537879c2
2 changed files with 5 additions and 1 deletions

View File

@@ -33,7 +33,9 @@ type DelayingInterface interface {
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 {
return NewDelayingQueueWithCustomClock(clock.RealClock{}, "")
}