health

Documentation

Index

• type Checker
• type Health
  • func New(opts ...Option) *Health
  • func (h *Health) CheckLive(ctx context.Context) Result
  • func (h *Health) CheckReady(ctx context.Context) Result
• type Option
  • func WithLiveCheck(check Checker) Option
  • func WithMaxConcurrent(maxConcurrent int) Option
  • func WithReadyCheck(check Checker) Option
• type Result
• type SingleCheckResult
• type Status
  • func (s Status) String() string

Types

type Checker

type Checker interface {
	Name() string
	Check(ctx context.Context) error
}

type Health

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

func New

func New(opts ...Option) *Health

func (*Health) CheckLive

func (h *Health) CheckLive(ctx context.Context) Result

func (*Health) CheckReady

func (h *Health) CheckReady(ctx context.Context) Result

type Option

type Option func(cfg *config)

func WithLiveCheck

func WithLiveCheck(check Checker) Option

func WithMaxConcurrent

func WithMaxConcurrent(maxConcurrent int) Option

func WithReadyCheck

func WithReadyCheck(check Checker) Option

type Result

type Result struct {
	Status Status
	Checks map[string][]SingleCheckResult
}

type SingleCheckResult

type SingleCheckResult struct {
	Status Status
	Err    error
	Time   time.Time
}

type Status

type Status string

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

func (Status) String

func (s Status) String() string