healthz

Documentation

Index

• Constants
• func CheckerFunc(h Manager) healthz.Checker
• func NewAPIServerHealthz(ctx context.Context, restClient rest.Interface) healthz.Checker
• func NewCacheSyncHealthz(cacheSyncWaiter cacheSyncWaiter) healthz.Checker
• type Manager
  • func NewDefaultHealthz() Manager
  • func NewPeriodicHealthz(clock clock.Clock, resetDuration time.Duration) Manager

Constants

const DefaultHealthManagerName = "default"

DefaultHealthManagerName is the name of the default health manager.

const PeriodicHealthManagerName = "periodic"

PeriodicHealthManagerName is the name of the periodic health manager.

Functions

func CheckerFunc

func CheckerFunc(h Manager) healthz.Checker

CheckerFunc returns a new healthz.Checker that will pass only if the given health manager returns true.

func NewAPIServerHealthz

func NewAPIServerHealthz(ctx context.Context, restClient rest.Interface) healthz.Checker

NewAPIServerHealthz returns a new healthz.Checker that will pass only if the /healthz endpoint of the API server returns status code 200.

func NewCacheSyncHealthz

func NewCacheSyncHealthz(cacheSyncWaiter cacheSyncWaiter) healthz.Checker

NewCacheSyncHealthz returns a new healthz.Checker that will pass only if all informers in the given cacheSyncWaiter sync.

Types

type Manager

type Manager interface {
	// Name returns the name of the health manager.
	Name() string
	// Start starts the health manager.
	Start(context.Context) error
	// Stop stops the health manager.
	Stop()
	// Get returns the current health status.
	Get() bool
	// Set updates the current health status with the given value.
	Set(bool)
}

Manager is an interface for health managers.

func NewDefaultHealthz

func NewDefaultHealthz() Manager

NewDefaultHealthz returns a default health manager that stores the given health status and returns it.

func NewPeriodicHealthz

func NewPeriodicHealthz(clock clock.Clock, resetDuration time.Duration) Manager

NewPeriodicHealthz returns a health manager that automatically sets the health status to false after the given reset duration. The timer is reset again when the health status is true (i.e., a running timer is reset and starts again from the beginning).