health

Documentation

Index

• func Add(checker *HealthChecker)
• type CheckResult
  • func CheckAll(ctx context.Context) []*CheckResult
  • func NewCheckResult(healthCheck *HealthChecker, duration time.Duration, err error) *CheckResult
  • func (c *CheckResult) IsOk() bool
• type Checker
• type HealthChecker
  • func NewHealthChecker(name string, description string, checker Checker, required bool, enabled bool) *HealthChecker
  • func (c *HealthChecker) IsRequired() bool

Functions

func Add

func Add(checker *HealthChecker)

Types

type CheckResult

type CheckResult struct {
	HealthCheck *HealthChecker
	Duration    time.Duration
	Error       error
}

func CheckAll

func CheckAll(ctx context.Context) []*CheckResult

func NewCheckResult

func NewCheckResult(healthCheck *HealthChecker, duration time.Duration, err error) *CheckResult

func (*CheckResult) IsOk

func (c *CheckResult) IsOk() bool

type Checker

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

type HealthChecker

type HealthChecker struct {
	Name        string
	Description string
	Checker     Checker
	Required    bool
	Enabled     bool
}

func NewHealthChecker

func NewHealthChecker(name string, description string, checker Checker, required bool, enabled bool) *HealthChecker

func (*HealthChecker) IsRequired

func (c *HealthChecker) IsRequired() bool