health

Documentation

Index

• func HTTPProbe(config HTTPProbeConfigOptions) error
• func IsHTTPProbeReady(res *http.Response) bool
• func IsHTTPProbeShuttingDown(res *http.Response) bool
• func ProbeHandler(healthState *State, prober func() bool, isAggressive bool, tracingEnabled bool, ...) http.HandlerFunc
• func TCPProbe(config TCPProbeConfigOptions) error
• type HTTPProbeConfigOptions
• type State
  • func (h *State) DrainHandlerFunc() func(_ http.ResponseWriter, _ *http.Request)
  • func (h *State) HandleHealthProbe(prober func() bool, isAggressive bool, w http.ResponseWriter)
  • func (h *State) IsAlive() bool
  • func (h *State) IsShuttingDown() bool
  • func (h *State) Shutdown(drain func())
• type TCPProbeConfigOptions

Functions

func HTTPProbe

func HTTPProbe(config HTTPProbeConfigOptions) error

HTTPProbe checks that HTTP connection can be established to the address.

func IsHTTPProbeReady

func IsHTTPProbeReady(res *http.Response) bool

IsHTTPProbeReady checks whether we received a successful Response

func IsHTTPProbeShuttingDown

func IsHTTPProbeShuttingDown(res *http.Response) bool

IsHTTPProbeShuttingDown checks whether the Response indicates the prober is shutting down.

func ProbeHandler

func ProbeHandler(healthState *State, prober func() bool, isAggressive bool, tracingEnabled bool, next http.Handler) http.HandlerFunc

ProbeHandler returns a http.HandlerFunc that responds to health checks if the knative network probe header is passed, and otherwise delegates to the next handler.

func TCPProbe

func TCPProbe(config TCPProbeConfigOptions) error

TCPProbe checks that a TCP socket to the address can be opened. Did not reuse k8s.io/kubernetes/pkg/probe/tcp to not create a dependency on klog.

Types

type HTTPProbeConfigOptions

type HTTPProbeConfigOptions struct {
	Timeout time.Duration
	*corev1.HTTPGetAction
	KubeMajor string
	KubeMinor string
}

HTTPProbeConfigOptions holds the HTTP probe config options

type State

type State struct {
	// contains filtered or unexported fields
}

State holds state about the current healthiness of the component.

func (*State) DrainHandlerFunc

func (h *State) DrainHandlerFunc() func(_ http.ResponseWriter, _ *http.Request)

DrainHandlerFunc constructs an HTTP handler that waits until the proxy server is shut down.

func (*State) HandleHealthProbe

func (h *State) HandleHealthProbe(prober func() bool, isAggressive bool, w http.ResponseWriter)

HandleHealthProbe handles the probe according to the current state of the health server. If isAggressive is false and prober has succeeded previously, the function returns success without probing user-container again (until shutdown).

func (*State) IsAlive

func (h *State) IsAlive() bool

IsAlive returns whether or not the health server is in a known working state currently.

func (*State) IsShuttingDown

func (h *State) IsShuttingDown() bool

IsShuttingDown returns whether or not the health server is currently shutting down.

func (*State) Shutdown

func (h *State) Shutdown(drain func())

Shutdown marks the proxy server as no ready and begins its shutdown process. This results in unblocking any connections waiting for drain.

type TCPProbeConfigOptions

type TCPProbeConfigOptions struct {
	SocketTimeout time.Duration
	Address       string
}

TCPProbeConfigOptions holds the TCP probe config options