health

Documentation

Index

• func TCPProbe(addr string, socketTimeout time.Duration) error
• type State
  • func (h *State) HealthHandler(prober func() bool) func(w http.ResponseWriter, r *http.Request)
  • func (h *State) IsAlive() bool
  • func (h *State) IsShuttingDown() bool
  • func (h *State) QuitHandler(cleaner func()) func(w http.ResponseWriter, r *http.Request)

Functions

func TCPProbe

func TCPProbe(addr string, socketTimeout time.Duration) 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 State

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

State holds state about the current healthiness of the component.

func (*State) HealthHandler

func (h *State) HealthHandler(prober func() bool) func(w http.ResponseWriter, r *http.Request)

HealthHandler constructs a handler that returns the current state of the health server.

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) QuitHandler

func (h *State) QuitHandler(cleaner func()) func(w http.ResponseWriter, r *http.Request)

QuitHandler constructs a handler that shuts the current server down. Optional cleanup logic can be added via the given cleaner function.