health

package

v0.2.1 Latest Latest Go to latest Published: Dec 8, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

View Source

const (
	StatusKey       = "status"
	UnHealthyStatus = "fail"
	HealthyStatus   = "pass"
)

This section is empty.

func Serv(hc Checker)

Serv start http server that contains ready, live and health endpoints warning: this function is blocking

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

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

func NewChecker(l logger.Logger) Checker

func (c *Checker) IsHealthy() Health

func (c *Checker) RegisterCheck(name string, check ICheck)

type FakeHealthyCheck struct {
}

func (FakeHealthyCheck) CheckHealth(context context.Context) Health

type FakeUnhealthyCheck struct {
}

func (FakeUnhealthyCheck) CheckHealth(context context.Context) Health

type Health struct {
	IsHealthy bool
	Info      map[string]any
}

Health a Health status struct

func NewHealth(isHealthy bool) Health

type ICheck interface {
	CheckHealth(context context.Context) Health
}