health

Documentation

Index

• Constants
• type App
  • func New(config Config, pingers ...model.Pinger) App
• type Config
  • func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config

Constants

const (
	// HealthPath is the path for checking that HTTP service is live
	HealthPath = "/health"

	// ReadyPath is the path for checking that HTTP service is ready (checking dependencies)
	ReadyPath = "/ready"
)

Types

type App

type App interface {
	Handler() http.Handler
	WaitForTermination(<-chan struct{})
	Done() <-chan struct{}
	End() <-chan struct{}
}

App of package

func New

func New(config Config, pingers ...model.Pinger) App

New creates new App from Config

type Config

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

Config of package

func Flags

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

Flags adds flags for configuring package