healthcheck

Documentation

Overview

Package healthcheck provides configuration of startup probes.

Index

• type Check
• type HealthChecker
  • func NewDefaultHealthChecker() (HealthChecker, error)

Types

type Check

type Check func(ctx context.Context) error

Check is a function that determines the health of the HealtChecker.

type HealthChecker

type HealthChecker interface {
	AddHTTPCheck(name string, url string) error
	AddPgCheck(name string, dsn string) error
	AddCheck(name string, check Check) error
	GetHandler() http.Handler
}

HealthChecker manages checks for determining the healhiness of a component.

func NewDefaultHealthChecker

func NewDefaultHealthChecker() (HealthChecker, error)

NewDefaultHealthChecker creates a new HealthCheker implementation using hellofresh/health-go.