health

package

v0.0.10-dev Latest Latest Go to latest Published: Feb 7, 2024 License: Apache-2.0 Imports: 0 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 {
	DoHealthCheck() (Health, error)
}

type Health interface {
	HealthStatus() Status
	Details() map[string]any
}

func Down(options ...Option) Health

func Of(status Status, options ...Option) Health

func OutOfService(options ...Option) Health

func Unknown(options ...Option) Health

func Up(options ...Option) Health

type Option interface {
	// contains filtered or unexported methods
}

func WithDetails(details map[string]any) Option

type Status int

const (
	StatusUnknown Status = iota + 1
	StatusUp
	StatusDown
	StatusOutOfService
)

Path	Synopsis
availability