healthcheck

Documentation

Index

• Variables
• func NewHandler(checkers ...Checker) jin.HandlerFunc
• func Register(e *jin.Engine)
• func RegisterHealthChecker(checkers ...Checker) error
• type Checker
• type Status
  • func NewStatus(n int) *Status
  • func (s *Status) Each(f func(string, StatusCode))
  • func (s *Status) Get(k string) (StatusCode, bool)
  • func (s *Status) Set(k string, v StatusCode)
  • func (s *Status) String(verbose bool) string
• type StatusCode

Variables

var (
	ErrConflictCheckerName = errors.New("health checker names conflict")
	ErrCheckFailed         = errors.New("health check failed")
)

Functions

func NewHandler

func NewHandler(checkers ...Checker) jin.HandlerFunc

func Register

func Register(e *jin.Engine)

func RegisterHealthChecker

func RegisterHealthChecker(checkers ...Checker) error

Types

type Checker

type Checker interface {
	Pass() bool
	Name() string
}

type Status

type Status struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewStatus

func NewStatus(n int) *Status

func (*Status) Each

func (s *Status) Each(f func(string, StatusCode))

func (*Status) Get

func (s *Status) Get(k string) (StatusCode, bool)

func (*Status) Set

func (s *Status) Set(k string, v StatusCode)

func (*Status) String

func (s *Status) String(verbose bool) string

type StatusCode

type StatusCode int

const (
	StatusOK StatusCode = iota
	StatusExcluded
	StatusError
)