health

Documentation

Overview

Package health provides liveness and readiness tracking for the router.

Index

• type State
  • func New() *State
  • func (s *State) Handler() http.Handler
  • func (s *State) IsLive() bool
  • func (s *State) IsReady() bool
  • func (s *State) SetLive(v bool)
  • func (s *State) SetReady(v bool)

Types

type State

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

State tracks liveness and readiness atomically.

func New

func New() *State

New returns a State with live=true and ready=true.

func (*State) Handler

func (s *State) Handler() http.Handler

Handler returns an http.Handler for the health check endpoint. Returns {"status":"UP"} with HTTP 200 when healthy, {"status":"DOWN"} with HTTP 503 when unhealthy.

func (*State) IsLive

func (s *State) IsLive() bool

IsLive reports whether the router is live.

func (*State) IsReady

func (s *State) IsReady() bool

IsReady reports whether the router is ready to serve requests.

func (*State) SetLive

func (s *State) SetLive(v bool)

SetLive sets the liveness state.

func (*State) SetReady

func (s *State) SetReady(v bool)

SetReady sets the readiness state.