health

package

v1.0.0 Latest Latest Go to latest Published: Apr 6, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

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

func New(opts ...Option) *Health

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

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

type Option func(cfg *config)

func WithLiveCheck(check Checker) Option

func WithMaxConcurrent(max int) Option

func WithReadyCheck(check Checker) Option

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

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

type Status string

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

func (s Status) String() string