health

README

Health

Package contains tools that allow to add REST endpoint for handling health and readiness requests. Package also provides implementation for most typical checks that may be done to figure our if service is healthy/ready.

HTTP Handler

A handler to serve checks using /health and /ready endpoints can be added to your service in a following way:

	healthChecker := health.NewChecksHandler("/health", "/ready"),
	)
	healthChecker.AddReadiness("Readiness check name", readinessCheck)
	healthChecker.AddLiveness("Liveness check name", livenessCheck)

	s, err := server.NewServer(
		// register our health checks
		server.WithHealthChecks(healthChecker),
	)

In a sample above readinessCheck and livenessCheck are functions that perform a single check. It is possible to add multiple checks independently and handler will call them in sequence.

Checks

Packange provides several predefined checks:

• DNSProbeCheck(host string, timeout time.Duration) returns a Check that determines whether a service with specified DNS name is reachable or not using net.Resolver's LookupHost method.
• HTTPGetCheck(url string, timeout time.Duration) returns a Check that performs an HTTP GET request to the specified URL. It fails if timeout was exceeded or non-200-OK status code returned.

Documentation

Index

• func WithLogger(logger *logrus.Logger) func(*ChecksHandler)
• type Check
  • func DNSProbeCheck(host string, timeout time.Duration) Check
  • func HTTPGetCheck(url string, timeout time.Duration) Check
• type Checker
  • func NewChecksHandler(healthPath, readyPath string) Checker
• type ChecksHandler
  • func NewChecksHandlerWithOptions(healthPath, readyPath string, options ...func(*ChecksHandler)) *ChecksHandler
  • func (ch *ChecksHandler) AddLiveness(name string, check Check)
  • func (ch *ChecksHandler) AddReadiness(name string, check Check)
  • func (ch *ChecksHandler) Handler() http.Handler
  • func (ch *ChecksHandler) RegisterHandler(mux *http.ServeMux)

Functions

func WithLogger

func WithLogger(logger *logrus.Logger) func(*ChecksHandler)

Types

type Check

type Check func() error

Check

func DNSProbeCheck

func DNSProbeCheck(host string, timeout time.Duration) Check

DNSProbeCheck returns a Check that determines whether a service with specified DNS name is reachable or not using net.Resolver's LookupHost method.

func HTTPGetCheck

func HTTPGetCheck(url string, timeout time.Duration) Check

HTTPGetCheck returns a Check that performs an HTTP GET request to the specified URL. It fails if timeout was exceeded or non-200-OK status code returned.

type Checker

type Checker interface {
	AddLiveness(name string, check Check)
	AddReadiness(name string, check Check)
	Handler() http.Handler
	RegisterHandler(mux *http.ServeMux)
}

Checker ...

func NewChecksHandler

func NewChecksHandler(healthPath, readyPath string) Checker

NewChecksHandler accepts two strings: health and ready paths. These paths will be used for liveness and readiness checks.

type ChecksHandler

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

func NewChecksHandlerWithOptions

func NewChecksHandlerWithOptions(healthPath, readyPath string, options ...func(*ChecksHandler)) *ChecksHandler

func (*ChecksHandler) AddLiveness

func (ch *ChecksHandler) AddLiveness(name string, check Check)

func (*ChecksHandler) AddReadiness

func (ch *ChecksHandler) AddReadiness(name string, check Check)

func (*ChecksHandler) Handler

func (ch *ChecksHandler) Handler() http.Handler

Handler returns a new http.Handler for the given health checker

func (*ChecksHandler) RegisterHandler

func (ch *ChecksHandler) RegisterHandler(mux *http.ServeMux)

RegisterHandler registers the given health and readiness patterns onto the given http.ServeMux