health

Documentation

Index

• Variables
• type Checker
  • func NewChecker() *Checker
  • func (h *Checker) Check() *Response
  • func (h *Checker) Register(name string, critical bool, provider Provider) error
  • func (h *Checker) SetEnabled(providerName string, enabled bool)
• type Health
• type Provider
• type Response
• type Status

Variables

var (
	ErrAlreadyRegistered = errors.New("already registered")
)

Types

type Checker

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

func NewChecker

func NewChecker() *Checker

func (*Checker) Check

func (h *Checker) Check() *Response

func (*Checker) Register

func (h *Checker) Register(name string, critical bool, provider Provider) error

func (*Checker) SetEnabled

func (h *Checker) SetEnabled(providerName string, enabled bool)

type Health

type Health struct {
	Status Status `json:"status"`
	Reason string `json:"reason,omitempty"`
}

type Provider

type Provider interface {
	Check() Health
}

type Response

type Response struct {
	Status  Status            `json:"status"`
	Details map[string]Health `json:"details"`
}

type Status

type Status = string

const (
	StatusUp       Status = "UP"
	StatusDown     Status = "DOWN"
	StatusDisabled Status = "DISABLED"
)