healthcheck

Documentation

Index

• Constants
• type Checker
• type CheckerFunc
  • func (r CheckerFunc) Healthcheck(ctx context.Context) error
• type Detail
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Handler() http.Handler
  • func (r *Registry) Register(name string, checker Checker)
• type Result

Constants

const (
	StatusPass = "pass"
	StatusFail = "fail"
)

Types

type Checker

type Checker interface {
	Healthcheck(ctx context.Context) error
}

type CheckerFunc

type CheckerFunc func(ctx context.Context) error

func (CheckerFunc) Healthcheck

func (r CheckerFunc) Healthcheck(ctx context.Context) error

type Detail

type Detail struct {
	ComponentName string
	ComponentType string
	Status        string
	Output        string `json:",omitempty"`
	Time          time.Time
}

type Registry

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

func NewRegistry

func NewRegistry() *Registry

func (*Registry) Handler

func (r *Registry) Handler() http.Handler

func (*Registry) Register

func (r *Registry) Register(name string, checker Checker)

type Result

type Result struct {
	Status  string
	Details map[string][]Detail
}