health

Documentation

Index

• Constants
• type Config
  • func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) *Config
• type Service
  • func New(ctx context.Context, config *Config, pingers ...model.Pinger) *Service
  • func (s *Service) DoneCtx() context.Context
  • func (s *Service) EndCtx() context.Context
  • func (s *Service) HealthHandler() http.Handler
  • func (s *Service) ReadyHandler() http.Handler
  • func (s *Service) WaitForTermination(done <-chan struct{}, signals ...os.Signal)

Constants

const (
	LivePath  = "/health"
	ReadyPath = "/ready"
)

Types

type Config

type Config struct {
	OkStatus      int
	GraceDuration time.Duration
}

func Flags

func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) *Config

type Service

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

func New

func New(ctx context.Context, config *Config, pingers ...model.Pinger) *Service

func (*Service) DoneCtx

func (s *Service) DoneCtx() context.Context

func (*Service) EndCtx

func (s *Service) EndCtx() context.Context

func (*Service) HealthHandler

func (s *Service) HealthHandler() http.Handler

func (*Service) ReadyHandler

func (s *Service) ReadyHandler() http.Handler

func (*Service) WaitForTermination

func (s *Service) WaitForTermination(done <-chan struct{}, signals ...os.Signal)