health

Documentation

Index

• func WaitForTestDial(ctx context.Context, addr *net.UnixAddr)
• type Checker
  • func NewChecker(config Config, log logrus.FieldLogger) *Checker
  • func (c *Checker) AddCheck(name string, checker health.ICheckable) error
  • func (c *Checker) ListenAndServe(ctx context.Context) error
• type Config
• type Details

Functions

func WaitForTestDial

func WaitForTestDial(ctx context.Context, addr *net.UnixAddr)

WaitForTestDial tries to create a client connection to the given target with a blocking dial and a timeout specified in testDialTimeout. Nothing is done with the connection, which is just closed in case it is created.

Types

type Checker

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

Checker is responsible for running health checks and serving the healthcheck HTTP paths

func NewChecker

func NewChecker(config Config, log logrus.FieldLogger) *Checker

func (*Checker) AddCheck

func (c *Checker) AddCheck(name string, checker health.ICheckable) error

func (*Checker) ListenAndServe

func (c *Checker) ListenAndServe(ctx context.Context) error

type Config

type Config struct {
	ListenerEnabled bool `hcl:"listener_enabled"`

	// Address and port to listen on, defaulting to localhost:80
	BindAddress string `hcl:"bind_address"`
	BindPort    string `hcl:"bind_port"`

	// Paths for /ready and /live
	ReadyPath string `hcl:"ready_path"`
	LivePath  string `hcl:"live_path"`

	UnusedKeys []string `hcl:",unusedKeys"`
}

type Details

type Details struct {
	Message string `json:"message,omitempty"`
}

Details are additional data to be used when the system is ready