healthcheck

README

healthcheck check the provided checks.

Usage

// register checks
registrar := healthcheck.NewRegistrar()
registrar.RegisterAsyncCheck(10*time.Second, 5*time.Second, healthcheck.Check{
		Name: "dummy",
		Check: func(ctx context.Context) error {
			// error make this check fail, nil will make it succeed
			return nil
		},
})
ck := registrar.BuildChecker(simple_checker.New())

// start all checks
ck.Start()

// get check result
ck.Check(ctx)

Documentation

Index

• func NewRegistrar(logger log.Logger) *registrar
• type Check
• type Checker
• type Registrar
• type Result

Functions

func NewRegistrar

func NewRegistrar(logger log.Logger) *registrar

Types

type Check

type Check struct {
	Name    string
	Check   func(ctx context.Context) error
	Timeout time.Duration

	UpdateInterval time.Duration
	InitialDelay   time.Duration
}

Check represent a health check

type Checker

type Checker interface {
	Start()
	Stop()
	Check(ctx context.Context) Result
	Build([]Check)
}

type Registrar

type Registrar interface {
	// RegisterCheck(check Check)   // register a sync check
	RegisterAsyncCheck(refreshPeriod time.Duration, initialDelay time.Duration, check Check)
	BuildChecker(checker Checker) Checker
}

Registrar supports check registration and checker creation.

type Result

type Result struct {
	Status string
}