probe

Documentation

Index

• type HealthService
  • func NewHealthService() HealthService
• type LivenessProbe
  • func (p *LivenessProbe) LivenessHandler(w http.ResponseWriter, r *http.Request)
  • func (p *LivenessProbe) Lock()
  • func (p *LivenessProbe) Unlock()
• type ReadyProbe
  • func (p *ReadyProbe) IsReady() bool
  • func (p *ReadyProbe) ReadyHandler(w http.ResponseWriter, r *http.Request)
  • func (p *ReadyProbe) SetReady()

Types

type HealthService

type HealthService interface {
	Register(server *grpc.Server)
	SetServing()
	Shutdown()
}

func NewHealthService

func NewHealthService() HealthService

type LivenessProbe

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

LivenessProbe wraps a liveness probe handler.

func (*LivenessProbe) LivenessHandler

func (p *LivenessProbe) LivenessHandler(w http.ResponseWriter, r *http.Request)

LivenessHandler writes back the HTTP status code 200 if the operator is ready, and 500 otherwise.

func (*LivenessProbe) Lock

func (p *LivenessProbe) Lock()

Lock the probe, preventing the LivenessHandler from responding to requests.

func (*LivenessProbe) Unlock

func (p *LivenessProbe) Unlock()

Unlock the probe, allowing the LivenessHandler to respond to requests.

type ReadyProbe

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

ReadyProbe wraps a readiness probe handler.

func (*ReadyProbe) IsReady

func (p *ReadyProbe) IsReady() bool

IsReady returns true when the given probe has been marked ready.

func (*ReadyProbe) ReadyHandler

func (p *ReadyProbe) ReadyHandler(w http.ResponseWriter, r *http.Request)

ReadyHandler writes back the HTTP status code 200 if the operator is ready, and 500 otherwise.

func (*ReadyProbe) SetReady

func (p *ReadyProbe) SetReady()

SetReady marks the probe as ready.