client-go – k8s.io/client-go/util/workqueue Index | Files

package workqueue

import "k8s.io/client-go/util/workqueue"

Package workqueue provides a simple queue that supports the following features:

Index

Functions

func ParallelizeUntil 

func ParallelizeUntil(ctx context.Context, workers, pieces int, doWorkPiece DoWorkPieceFunc, opts ...Options)

ParallelizeUntil is a framework that allows for parallelizing N independent pieces of work until done or the context is canceled.

func SetProvider 

func SetProvider(metricsProvider MetricsProvider)

SetProvider sets the metrics provider for all subsequently created work queues. Only the first call has an effect.

func WithChunkSize 

func WithChunkSize(c int) func(*options)

WithChunkSize allows to set chunks of work items to the workers, rather than processing one by one. It is recommended to use this option if the number of pieces significantly higher than the number of workers and the work done for each item is small.

Types

type BucketRateLimiter 

type BucketRateLimiter = TypedBucketRateLimiter[any]

Deprecated: BucketRateLimiter is deprecated, use TypedBucketRateLimiter instead.

type CounterMetric 

type CounterMetric interface {
	Inc()
}

CounterMetric represents a single numerical value that only ever goes up.

type DelayingInterface 

type DelayingInterface TypedDelayingInterface[any]

DelayingInterface is an Interface that can Add an item at a later time. This makes it easier to requeue items after failures without ending up in a hot-loop.

Deprecated: use TypedDelayingInterface instead.

func NewDelayingQueue 

func NewDelayingQueue() DelayingInterface

NewDelayingQueue constructs a new workqueue with delayed queuing ability. NewDelayingQueue does not emit metrics. For use with a MetricsProvider, please use NewDelayingQueueWithConfig instead and specify a name.

Deprecated: use NewTypedDelayingQueue instead.

func NewDelayingQueueWithConfig 

func NewDelayingQueueWithConfig(config DelayingQueueConfig) DelayingInterface

NewDelayingQueueWithConfig constructs a new workqueue with options to customize different properties.

Deprecated: use NewTypedDelayingQueueWithConfig instead.

func NewDelayingQueueWithCustomClock 

func NewDelayingQueueWithCustomClock(clock clock.WithTicker, name string) DelayingInterface

NewDelayingQueueWithCustomClock constructs a new named workqueue with ability to inject real or fake clock for testing purposes. Deprecated: Use NewDelayingQueueWithConfig instead.

func NewDelayingQueueWithCustomQueue 

func NewDelayingQueueWithCustomQueue(q Interface, name string) DelayingInterface

NewDelayingQueueWithCustomQueue constructs a new workqueue with ability to inject custom queue Interface instead of the default one Deprecated: Use NewDelayingQueueWithConfig instead.

func NewNamedDelayingQueue 

func NewNamedDelayingQueue(name string) DelayingInterface

NewNamedDelayingQueue constructs a new named workqueue with delayed queuing ability. Deprecated: Use NewDelayingQueueWithConfig instead.

type DelayingQueueConfig 

type DelayingQueueConfig = TypedDelayingQueueConfig[any]

DelayingQueueConfig specifies optional configurations to customize a DelayingInterface.

Deprecated: use TypedDelayingQueueConfig instead.

type DoWorkPieceFunc 

type DoWorkPieceFunc func(piece int)

type GaugeMetric 

type GaugeMetric interface {
	Inc()
	Dec()
}

GaugeMetric represents a single numerical value that can arbitrarily go up and down.

type HistogramMetric 

type HistogramMetric interface {
	Observe(float64)
}

HistogramMetric counts individual observations.

type Interface 

type Interface TypedInterface[any]

Deprecated: Interface is deprecated, use TypedInterface instead.

type ItemExponentialFailureRateLimiter 

type ItemExponentialFailureRateLimiter = TypedItemExponentialFailureRateLimiter[any]

Deprecated: ItemExponentialFailureRateLimiter is deprecated, use TypedItemExponentialFailureRateLimiter instead.

type ItemFastSlowRateLimiter 

type ItemFastSlowRateLimiter = TypedItemFastSlowRateLimiter[any]

ItemFastSlowRateLimiter does a quick retry for a certain number of attempts, then a slow retry after that Deprecated: Use TypedItemFastSlowRateLimiter instead.

type MaxOfRateLimiter 

type MaxOfRateLimiter = TypedMaxOfRateLimiter[any]

MaxOfRateLimiter calls every RateLimiter and returns the worst case response When used with a token bucket limiter, the burst could be apparently exceeded in cases where particular items were separately delayed a longer time.

Deprecated: Use TypedMaxOfRateLimiter instead.

type MetricsProvider 

type MetricsProvider interface {
	NewDepthMetric(name string) GaugeMetric
	NewAddsMetric(name string) CounterMetric
	NewLatencyMetric(name string) HistogramMetric
	NewWorkDurationMetric(name string) HistogramMetric
	NewUnfinishedWorkSecondsMetric(name string) SettableGaugeMetric
	NewLongestRunningProcessorSecondsMetric(name string) SettableGaugeMetric
	NewRetriesMetric(name string) CounterMetric
}

MetricsProvider generates various metrics used by the queue.

type Options 

type Options func(*options)

type Queue 

type Queue[T comparable] interface {
	// Touch can be hooked when an existing item is added again. This may be
	// useful if the implementation allows priority change for the given item.
	Touch(item T)
	// Push adds a new item.
	Push(item T)
	// Len tells the total number of items.
	Len() int
	// Pop retrieves an item.
	Pop() (item T)
}

Queue is the underlying storage for items. The functions below are always called from the same goroutine.

func DefaultQueue 

func DefaultQueue[T comparable]() Queue[T]

DefaultQueue is a slice based FIFO queue.

type QueueConfig 

type QueueConfig = TypedQueueConfig[any]

QueueConfig specifies optional configurations to customize an Interface. Deprecated: use TypedQueueConfig instead.

type RateLimiter 

type RateLimiter TypedRateLimiter[any]

Deprecated: RateLimiter is deprecated, use TypedRateLimiter instead.

func DefaultControllerRateLimiter 

func DefaultControllerRateLimiter() RateLimiter

DefaultControllerRateLimiter is a no-arg constructor for a default rate limiter for a workqueue. It has both overall and per-item rate limiting. The overall is a token bucket and the per-item is exponential

Deprecated: Use DefaultTypedControllerRateLimiter instead.

func DefaultItemBasedRateLimiter 

func DefaultItemBasedRateLimiter() RateLimiter

Deprecated: DefaultItemBasedRateLimiter is deprecated, use DefaultTypedItemBasedRateLimiter instead.

func NewItemExponentialFailureRateLimiter 

func NewItemExponentialFailureRateLimiter(baseDelay time.Duration, maxDelay time.Duration) RateLimiter

Deprecated: NewItemExponentialFailureRateLimiter is deprecated, use NewTypedItemExponentialFailureRateLimiter instead.

func NewItemFastSlowRateLimiter 

func NewItemFastSlowRateLimiter(fastDelay, slowDelay time.Duration, maxFastAttempts int) RateLimiter

Deprecated: NewItemFastSlowRateLimiter is deprecated, use NewTypedItemFastSlowRateLimiter instead.

func NewMaxOfRateLimiter 

func NewMaxOfRateLimiter(limiters ...TypedRateLimiter[any]) RateLimiter

Deprecated: NewMaxOfRateLimiter is deprecated, use NewTypedMaxOfRateLimiter instead.

func NewWithMaxWaitRateLimiter 

func NewWithMaxWaitRateLimiter(limiter RateLimiter, maxDelay time.Duration) RateLimiter

Deprecated: NewWithMaxWaitRateLimiter is deprecated, use NewTypedWithMaxWaitRateLimiter instead.

type RateLimitingInterface 

type RateLimitingInterface TypedRateLimitingInterface[any]

RateLimitingInterface is an interface that rate limits items being added to the queue.

Deprecated: Use TypedRateLimitingInterface instead.

func NewNamedRateLimitingQueue 

func NewNamedRateLimitingQueue(rateLimiter RateLimiter, name string) RateLimitingInterface

NewNamedRateLimitingQueue constructs a new named workqueue with rateLimited queuing ability. Deprecated: Use NewRateLimitingQueueWithConfig instead.

func NewRateLimitingQueue 

func NewRateLimitingQueue(rateLimiter RateLimiter) RateLimitingInterface

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 NewRateLimitingQueueWithConfig instead and specify a name.

Deprecated: Use NewTypedRateLimitingQueue instead.

func NewRateLimitingQueueWithConfig 

func NewRateLimitingQueueWithConfig(rateLimiter RateLimiter, config RateLimitingQueueConfig) RateLimitingInterface

NewRateLimitingQueueWithConfig constructs a new workqueue with rateLimited queuing ability with options to customize different properties. Remember to call Forget! If you don't, you may end up tracking failures forever.

Deprecated: Use NewTypedRateLimitingQueueWithConfig instead.

func NewRateLimitingQueueWithDelayingInterface 

func NewRateLimitingQueueWithDelayingInterface(di DelayingInterface, rateLimiter RateLimiter) RateLimitingInterface

NewRateLimitingQueueWithDelayingInterface constructs a new named workqueue with rateLimited queuing ability with the option to inject a custom delaying queue instead of the default one. Deprecated: Use NewRateLimitingQueueWithConfig instead.

type RateLimitingQueueConfig 

type RateLimitingQueueConfig = TypedRateLimitingQueueConfig[any]

RateLimitingQueueConfig specifies optional configurations to customize a RateLimitingInterface.

Deprecated: Use TypedRateLimitingQueueConfig instead.

type SettableGaugeMetric 

type SettableGaugeMetric interface {
	Set(float64)
}

SettableGaugeMetric represents a single numerical value that can arbitrarily go up and down. (Separate from GaugeMetric to preserve backwards compatibility.)

type SummaryMetric 

type SummaryMetric interface {
	Observe(float64)
}

SummaryMetric captures individual observations.

type Type 

type Type = Typed[any]

Type is a work queue (see the package comment). Deprecated: Use Typed instead.

func New 

func New() *Type

New constructs a new work queue (see the package comment).

Deprecated: use NewTyped instead.

func NewNamed 

func NewNamed(name string) *Type

NewNamed creates a new named queue. Deprecated: Use NewWithConfig instead.

func NewWithConfig 

func NewWithConfig(config QueueConfig) *Type

NewWithConfig constructs a new workqueue with ability to customize different properties.

Deprecated: use NewTypedWithConfig instead.

type Typed 

type Typed[t comparable] struct {
	// contains filtered or unexported fields
}

func NewTyped 

func NewTyped[T comparable]() *Typed[T]

NewTyped constructs a new work queue (see the package comment).

func NewTypedWithConfig 

func NewTypedWithConfig[T comparable](config TypedQueueConfig[T]) *Typed[T]

NewTypedWithConfig constructs a new workqueue with ability to customize different properties.

func (*Typed[T]) Add 

func (q *Typed[T]) Add(item T)

Add marks item as needing processing.

func (*Typed[T]) Done 

func (q *Typed[T]) Done(item T)

Done marks item as done processing, and if it has been marked as dirty again while it was being processed, it will be re-added to the queue for re-processing.

func (*Typed[T]) Get 

func (q *Typed[T]) Get() (item T, shutdown bool)

Get blocks until it can return an item to be processed. If shutdown = true, the caller should end their goroutine. You must call Done with item when you have finished processing it.

func (*Typed[T]) Len 

func (q *Typed[T]) Len() int

Len returns the current queue length, for informational purposes only. You shouldn't e.g. gate a call to Add() or Get() on Len() being a particular value, that can't be synchronized properly.

func (*Typed[T]) ShutDown 

func (q *Typed[T]) ShutDown()

ShutDown will cause q to ignore all new items added to it and immediately instruct the worker goroutines to exit.

func (*Typed[T]) ShutDownWithDrain 

func (q *Typed[T]) ShutDownWithDrain()

ShutDownWithDrain will cause q to ignore all new items added to it. As soon as the worker goroutines have "drained", i.e: finished processing and called Done on all existing items in the queue; they will be instructed to exit and ShutDownWithDrain will return. Hence: a strict requirement for using this is; your workers must ensure that Done is called on all items in the queue once the shut down has been initiated, if that is not the case: this will block indefinitely. It is, however, safe to call ShutDown after having called ShutDownWithDrain, as to force the queue shut down to terminate immediately without waiting for the drainage.

func (*Typed[T]) ShuttingDown 

func (q *Typed[T]) ShuttingDown() bool

type TypedBucketRateLimiter 

type TypedBucketRateLimiter[T comparable] struct {
	*rate.Limiter
}

TypedBucketRateLimiter adapts a standard bucket to the workqueue ratelimiter API

func (*TypedBucketRateLimiter[T]) Forget 

func (r *TypedBucketRateLimiter[T]) Forget(item T)

func (*TypedBucketRateLimiter[T]) NumRequeues 

func (r *TypedBucketRateLimiter[T]) NumRequeues(item T) int

func (*TypedBucketRateLimiter[T]) When 

func (r *TypedBucketRateLimiter[T]) When(item T) time.Duration

type TypedDelayingInterface 

type TypedDelayingInterface[T comparable] interface {
	TypedInterface[T]
	// AddAfter adds an item to the workqueue after the indicated duration has passed
	AddAfter(item T, duration time.Duration)
}

TypedDelayingInterface is an Interface that can Add an item at a later time. This makes it easier to requeue items after failures without ending up in a hot-loop.

func NewTypedDelayingQueue 

func NewTypedDelayingQueue[T comparable]() TypedDelayingInterface[T]

NewTypedDelayingQueue constructs a new workqueue with delayed queuing ability. NewTypedDelayingQueue does not emit metrics. For use with a MetricsProvider, please use NewTypedDelayingQueueWithConfig instead and specify a name.

func NewTypedDelayingQueueWithConfig 

func NewTypedDelayingQueueWithConfig[T comparable](config TypedDelayingQueueConfig[T]) TypedDelayingInterface[T]

NewTypedDelayingQueueWithConfig constructs a new workqueue with options to customize different properties.

func TypedNewDelayingQueue 

func TypedNewDelayingQueue[T comparable]() TypedDelayingInterface[T]

TypedNewDelayingQueue exists for backwards compatibility only.

Deprecated: use NewTypedDelayingQueueWithConfig instead.

type TypedDelayingQueueConfig 

type TypedDelayingQueueConfig[T comparable] struct {
	// An optional logger. The name of the queue does *not* get added to it, this should
	// be done by the caller if desired.
	Logger *klog.Logger

	// Name for the queue. If unnamed, the metrics will not be registered.
	Name string

	// MetricsProvider optionally allows specifying a metrics provider to use for the queue
	// instead of the global provider.
	MetricsProvider MetricsProvider

	// Clock optionally allows injecting a real or fake clock for testing purposes.
	Clock clock.WithTicker

	// Queue optionally allows injecting custom queue Interface instead of the default one.
	Queue TypedInterface[T]
}

TypedDelayingQueueConfig specifies optional configurations to customize a DelayingInterface.

type TypedInterface 

type TypedInterface[T comparable] interface {
	Add(item T)
	Len() int
	Get() (item T, shutdown bool)
	Done(item T)
	ShutDown()
	ShutDownWithDrain()
	ShuttingDown() bool
}

type TypedItemExponentialFailureRateLimiter 

type TypedItemExponentialFailureRateLimiter[T comparable] struct {
	// contains filtered or unexported fields
}

TypedItemExponentialFailureRateLimiter does a simple baseDelay*2^<num-failures> limit dealing with max failures and expiration are up to the caller

func (*TypedItemExponentialFailureRateLimiter[T]) Forget 

func (r *TypedItemExponentialFailureRateLimiter[T]) Forget(item T)

func (*TypedItemExponentialFailureRateLimiter[T]) NumRequeues 

func (r *TypedItemExponentialFailureRateLimiter[T]) NumRequeues(item T) int

func (*TypedItemExponentialFailureRateLimiter[T]) When 

func (r *TypedItemExponentialFailureRateLimiter[T]) When(item T) time.Duration

type TypedItemFastSlowRateLimiter 

type TypedItemFastSlowRateLimiter[T comparable] struct {
	// contains filtered or unexported fields
}

TypedItemFastSlowRateLimiter does a quick retry for a certain number of attempts, then a slow retry after that

func (*TypedItemFastSlowRateLimiter[T]) Forget 

func (r *TypedItemFastSlowRateLimiter[T]) Forget(item T)

func (*TypedItemFastSlowRateLimiter[T]) NumRequeues 

func (r *TypedItemFastSlowRateLimiter[T]) NumRequeues(item T) int

func (*TypedItemFastSlowRateLimiter[T]) When 

func (r *TypedItemFastSlowRateLimiter[T]) When(item T) time.Duration

type TypedMaxOfRateLimiter 

type TypedMaxOfRateLimiter[T comparable] struct {
	// contains filtered or unexported fields
}

TypedMaxOfRateLimiter calls every RateLimiter and returns the worst case response When used with a token bucket limiter, the burst could be apparently exceeded in cases where particular items were separately delayed a longer time.

func (*TypedMaxOfRateLimiter[T]) Forget 

func (r *TypedMaxOfRateLimiter[T]) Forget(item T)

func (*TypedMaxOfRateLimiter[T]) NumRequeues 

func (r *TypedMaxOfRateLimiter[T]) NumRequeues(item T) int

func (*TypedMaxOfRateLimiter[T]) When 

func (r *TypedMaxOfRateLimiter[T]) When(item T) time.Duration

type TypedQueueConfig 

type TypedQueueConfig[T comparable] struct {
	// Name for the queue. If unnamed, the metrics will not be registered.
	Name string

	// MetricsProvider optionally allows specifying a metrics provider to use for the queue
	// instead of the global provider.
	MetricsProvider MetricsProvider

	// Clock ability to inject real or fake clock for testing purposes.
	Clock clock.WithTicker

	// Queue provides the underlying queue to use. It is optional and defaults to slice based FIFO queue.
	Queue Queue[T]
}

type TypedRateLimiter 

type TypedRateLimiter[T comparable] interface {
	// When gets an item and gets to decide how long that item should wait
	When(item T) time.Duration
	// Forget indicates that an item is finished being retried.  Doesn't matter whether it's for failing
	// or for success, we'll stop tracking it
	Forget(item T)
	// NumRequeues returns back how many failures the item has had
	NumRequeues(item T) int
}

func DefaultTypedControllerRateLimiter 

func DefaultTypedControllerRateLimiter[T comparable]() TypedRateLimiter[T]

DefaultTypedControllerRateLimiter is a no-arg constructor for a default rate limiter for a workqueue. It has both overall and per-item rate limiting. The overall is a token bucket and the per-item is exponential

func DefaultTypedItemBasedRateLimiter 

func DefaultTypedItemBasedRateLimiter[T comparable]() TypedRateLimiter[T]

func NewTypedItemExponentialFailureRateLimiter 

func NewTypedItemExponentialFailureRateLimiter[T comparable](baseDelay time.Duration, maxDelay time.Duration) TypedRateLimiter[T]

func NewTypedItemFastSlowRateLimiter 

func NewTypedItemFastSlowRateLimiter[T comparable](fastDelay, slowDelay time.Duration, maxFastAttempts int) TypedRateLimiter[T]

func NewTypedMaxOfRateLimiter 

func NewTypedMaxOfRateLimiter[T comparable](limiters ...TypedRateLimiter[T]) TypedRateLimiter[T]

func NewTypedWithMaxWaitRateLimiter 

func NewTypedWithMaxWaitRateLimiter[T comparable](limiter TypedRateLimiter[T], maxDelay time.Duration) TypedRateLimiter[T]

type TypedRateLimitingInterface 

type TypedRateLimitingInterface[T comparable] interface {
	TypedDelayingInterface[T]

	// AddRateLimited adds an item to the workqueue after the rate limiter says it's ok
	AddRateLimited(item T)

	// 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 T)

	// NumRequeues returns back how many times the item was requeued
	NumRequeues(item T) int
}

TypedRateLimitingInterface is an interface that rate limits items being added to the queue.

func NewTypedRateLimitingQueue 

func NewTypedRateLimitingQueue[T comparable](rateLimiter TypedRateLimiter[T]) TypedRateLimitingInterface[T]

NewTypedRateLimitingQueue constructs a new workqueue with rateLimited queuing ability Remember to call Forget! If you don't, you may end up tracking failures forever. NewTypedRateLimitingQueue does not emit metrics. For use with a MetricsProvider, please use NewTypedRateLimitingQueueWithConfig instead and specify a name.

func NewTypedRateLimitingQueueWithConfig 

func NewTypedRateLimitingQueueWithConfig[T comparable](rateLimiter TypedRateLimiter[T], config TypedRateLimitingQueueConfig[T]) TypedRateLimitingInterface[T]

NewTypedRateLimitingQueueWithConfig constructs a new workqueue with rateLimited queuing ability with options to customize different properties. Remember to call Forget! If you don't, you may end up tracking failures forever.

type TypedRateLimitingQueueConfig 

type TypedRateLimitingQueueConfig[T comparable] struct {
	// Name for the queue. If unnamed, the metrics will not be registered.
	Name string

	// MetricsProvider optionally allows specifying a metrics provider to use for the queue
	// instead of the global provider.
	MetricsProvider MetricsProvider

	// Clock optionally allows injecting a real or fake clock for testing purposes.
	Clock clock.WithTicker

	// DelayingQueue optionally allows injecting custom delaying queue DelayingInterface instead of the default one.
	DelayingQueue TypedDelayingInterface[T]
}

TypedRateLimitingQueueConfig specifies optional configurations to customize a TypedRateLimitingInterface.

type TypedWithMaxWaitRateLimiter 

type TypedWithMaxWaitRateLimiter[T comparable] struct {
	// contains filtered or unexported fields
}

TypedWithMaxWaitRateLimiter have maxDelay which avoids waiting too long

func (TypedWithMaxWaitRateLimiter[T]) Forget 

func (w TypedWithMaxWaitRateLimiter[T]) Forget(item T)

func (TypedWithMaxWaitRateLimiter[T]) NumRequeues 

func (w TypedWithMaxWaitRateLimiter[T]) NumRequeues(item T) int

func (TypedWithMaxWaitRateLimiter[T]) When 

func (w TypedWithMaxWaitRateLimiter[T]) When(item T) time.Duration

type WithMaxWaitRateLimiter 

type WithMaxWaitRateLimiter = TypedWithMaxWaitRateLimiter[any]

WithMaxWaitRateLimiter have maxDelay which avoids waiting too long Deprecated: Use TypedWithMaxWaitRateLimiter instead.

Source Files

default_rate_limiters.go delaying_queue.go doc.go metrics.go parallelizer.go queue.go rate_limiting_queue.go

Version
v0.33.0 (latest)
Published
Apr 23, 2025
Platform
linux/amd64
Imports
9 packages
Last checked
25 minutes ago –

Tools for package owners.