health

Documentation

Index

• Constants
• type App
  • func New(config Config, pingers ...model.Pinger) App
  • func (a App) Context() context.Context
  • func (a App) Done() <-chan struct{}
  • func (a App) End() <-chan struct{}
  • func (a App) HealthHandler() http.Handler
  • func (a App) ReadyHandler() http.Handler
  • func (a App) WaitForTermination(done <-chan struct{})
• type Config
  • func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config

Constants

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

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

Types

type App

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

func New

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

func (App) Context

func (a App) Context() context.Context

Context of the app, canceled when App is Done()

func (App) Done

func (a App) Done() <-chan struct{}

Done returns the chan closed when SIGTERM is received.

func (App) End

func (a App) End() <-chan struct{}

End returns the chan closed when graceful duration is over.

func (App) HealthHandler

func (a App) HealthHandler() http.Handler

HealthHandler for request. Should be use with net/http.

func (App) ReadyHandler

func (a App) ReadyHandler() http.Handler

ReadyHandler for request. Should be use with net/http.

func (App) WaitForTermination

func (a App) WaitForTermination(done <-chan struct{})

WaitForTermination waits for SIGTERM or done plus grace duration.

type Config

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

func Flags

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