prober

Documentation

Index

• type Addressable
• type Cache
  • func NewLocalExpiringCache(ctx context.Context, expiration time.Duration) Cache
• type EnqueueFunc
• type ExpirationFunc
• type Func
  • func (p Func) Probe(ctx context.Context, addressable Addressable, expected Status) Status
• type Prober
  • func NewAsync(ctx context.Context, client httpClient, port string, ...) Prober
• type Status
  • func (s Status) String() string

Types

type Addressable

type Addressable struct {
	// Addressable address.
	Address *url.URL
	// Resource key.
	ResourceKey types.NamespacedName
}

Addressable contains addressable resource data for the prober.

type Cache

type Cache interface {
	// GetStatus retries the status associated with the given key.
	GetStatus(key string) Status
	// UpsertStatus add or updates the status associated with the given key.
	// Once the given key expires the onExpired callback will be called passing the arg parameter.
	UpsertStatus(key string, status Status, arg interface{}, onExpired ExpirationFunc)
}

Cache is a key-status store.

func NewLocalExpiringCache

func NewLocalExpiringCache(ctx context.Context, expiration time.Duration) Cache

type EnqueueFunc

type EnqueueFunc func(key types.NamespacedName)

EnqueueFunc enqueues the given provided resource key.

type ExpirationFunc

type ExpirationFunc func(key string, arg interface{})

ExpirationFunc is a callback called once an entry in the cache is expired.

type Func

type Func func(ctx context.Context, addressable Addressable, expected Status) Status

Func type is an adapter to allow the use of ordinary functions as Prober. If f is a function with the appropriate signature, Func(f) is a Prober that calls f.

func (Func) Probe

func (p Func) Probe(ctx context.Context, addressable Addressable, expected Status) Status

Probe implements the Prober interface for Func.

type Prober

type Prober interface {
	// Probe probes the provided Addressable resource and returns its Status.
	Probe(ctx context.Context, addressable Addressable, expected Status) Status
}

Prober probes an addressable resource.

func NewAsync

func NewAsync(ctx context.Context, client httpClient, port string, podsLabelsSelector labels.Selector, enqueue EnqueueFunc) Prober

NewAsync creates an async Prober.

It reports status changes using the provided EnqueueFunc.

type Status

type Status int

Status represents the resource status.

const (
	// StatusReady signals that a given object is ready.
	StatusReady Status = iota
	// StatusUnknown signals that a given object is not ready and its state is unknown.
	StatusUnknown
	// StatusNotReady signals that a given object is not ready.
	StatusNotReady
)

func (Status) String

func (s Status) String() string