health

Documentation

Index

• func HTTPProbe(config HTTPProbeConfigOptions) error
• func ProbeHandler(healthState *State, prober func() bool, tracingEnabled bool, next http.Handler) http.HandlerFunc
• func TCPProbe(config TCPProbeConfigOptions) error
• type HTTPProbeConfigOptions
• type State
  • func NewState() *State
  • func (h *State) DrainHandlerFunc() func(_ http.ResponseWriter, _ *http.Request)
  • func (h *State) HandleHealthProbe(prober func() bool, w http.ResponseWriter)
  • 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 ProbeHandler

func ProbeHandler(healthState *State, prober func() 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
	MaxProtoMajor int
}

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 NewState

func NewState() *State

NewState returns a new State with both alive and shuttingDown set to false.

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, w http.ResponseWriter)

HandleHealthProbe handles the probe according to the current state of the health server.

func (*State) Shutdown

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

Shutdown marks the proxy server as not 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