healthy

Documentation

Index

• type HealthWatchdog
  • func NewHealthWatchdog(name, port, healthPort string, service Service) *HealthWatchdog
  • func (w *HealthWatchdog) Run()
• type Service

Types

type HealthWatchdog

type HealthWatchdog struct {
	healthcheck.Handler
	// contains filtered or unexported fields
}

HealthWatchdog is a wrapper for healthy services. It takes care of the availability reporting and it automatically switches between ready and unavailable states based on readiness checks.

func NewHealthWatchdog

func NewHealthWatchdog(name, port, healthPort string, service Service) *HealthWatchdog

NewHealthWatchdog returns a watchdog that wraps and monitors the given service.

func (*HealthWatchdog) Run

func (w *HealthWatchdog) Run()

Run runs the healthy Service.

type Service

type Service interface {
	Initialize() (*http.Server, error)
	Live() error
	Ready() error
}

Service is the interface for an HTTP service supporting health queries.