health

Documentation

Index

• type Check
• type Checkable
• type Service
  • func NewService(checkFreq time.Duration, log logging.Logger, namespace string, ...) (Service, error)

Types

type Check

type Check func() (interface{}, error)

Check is a health check. Returns the health check results and, if unhealthy, a non-nil error.

type Checkable

type Checkable interface {
	// HealthCheck returns health check results and,
	// if not healthy, a non-nil error
	HealthCheck() (interface{}, error)
}

Checkable can have its health checked

type Service

type Service interface {
	RegisterCheck(name string, checkFn Check) error
	RegisterMonotonicCheck(name string, checkFn Check) error
	Results() (map[string]health.Result, bool)
}

Service performs health checks. Other things register health checks with Service, which performs them.

func NewService

func NewService(checkFreq time.Duration, log logging.Logger, namespace string, registry prometheus.Registerer) (Service, error)

NewService returns a new Service where the health checks run every [checkFreq]