mirror of
https://github.com/kubernetes/client-go.git
synced 2025-09-29 00:16:25 +00:00
5a537879c2
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
72 lines
2.4 KiB
Go
72 lines
2.4 KiB
Go
/*
|
|
Copyright 2016 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package workqueue
|
|
|
|
// RateLimitingInterface is an interface that rate limits items being added to the queue.
|
|
type RateLimitingInterface interface {
|
|
DelayingInterface
|
|
|
|
// AddRateLimited adds an item to the workqueue after the rate limiter says it's ok
|
|
AddRateLimited(item interface{})
|
|
|
|
// Forget indicates that an item is finished being retried. Doesn't matter whether it's for perm failing
|
|
// or for success, we'll stop the rate limiter from tracking it. This only clears the `rateLimiter`, you
|
|
// still have to call `Done` on the queue.
|
|
Forget(item interface{})
|
|
|
|
// NumRequeues returns back how many times the item was requeued
|
|
NumRequeues(item interface{}) int
|
|
}
|
|
|
|
// NewRateLimitingQueue constructs a new workqueue with rateLimited queuing ability
|
|
// 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 {
|
|
return &rateLimitingType{
|
|
DelayingInterface: NewDelayingQueue(),
|
|
rateLimiter: rateLimiter,
|
|
}
|
|
}
|
|
|
|
func NewNamedRateLimitingQueue(rateLimiter RateLimiter, name string) RateLimitingInterface {
|
|
return &rateLimitingType{
|
|
DelayingInterface: NewNamedDelayingQueue(name),
|
|
rateLimiter: rateLimiter,
|
|
}
|
|
}
|
|
|
|
// rateLimitingType wraps an Interface and provides rateLimited re-enquing
|
|
type rateLimitingType struct {
|
|
DelayingInterface
|
|
|
|
rateLimiter RateLimiter
|
|
}
|
|
|
|
// AddRateLimited AddAfter's the item based on the time when the rate limiter says it's ok
|
|
func (q *rateLimitingType) AddRateLimited(item interface{}) {
|
|
q.DelayingInterface.AddAfter(item, q.rateLimiter.When(item))
|
|
}
|
|
|
|
func (q *rateLimitingType) NumRequeues(item interface{}) int {
|
|
return q.rateLimiter.NumRequeues(item)
|
|
}
|
|
|
|
func (q *rateLimitingType) Forget(item interface{}) {
|
|
q.rateLimiter.Forget(item)
|
|
}
|