health

Documentation

Index

• type BasicChecker
  • func (h *BasicChecker) Check() error
• type Checker
• type UnhealthySystemError
  • func (e *UnhealthySystemError) Error() string
  • func (e *UnhealthySystemError) Unwrap() error

Types

type BasicChecker

type BasicChecker struct{}

BasicChecker supports a simple health check, which always returns nil

func (*BasicChecker) Check

func (h *BasicChecker) Check() error

Check always returns nil

type Checker

type Checker interface {
	Check() error
}

Checker includes methods necessary for managing and determining the health of the system

type UnhealthySystemError

type UnhealthySystemError struct {
	Err error
}

UnhealthySystemError represents an error returned if the system is not healthy. This error can be returned from a health manager to indicate that the response code returned should be a `503`

func (*UnhealthySystemError) Error

func (e *UnhealthySystemError) Error() string

Error returns an error string

func (*UnhealthySystemError) Unwrap

func (e *UnhealthySystemError) Unwrap() error

Unwrap returns the underlying error