health

package

v0.1.2 Latest Latest Go to latest Published: Mar 4, 2021 License: ISC Imports: 5 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

Package health is used for implementing health checks for services.

This section is empty.

This section is empty.

func HandlerFunc() http.HandlerFunc

HandlerFunc returns an http handler function for checking the health of registered checkers.

func RegisterChecker(c ...Checker)

RegisterChecker registers new health checkers.

func SetLogger(l Logger)

SetLogger enables logging.

func SetTimeout(d time.Duration)

SetTimeout sets the timeout for health checkers. If the timeout reaches, the health check is considered failed. The default timeout is 5 seconds.

type Checker interface {
	fmt.Stringer
	CheckHealth(context.Context) error
}

Checker is the interface for checking the health of a component.

type Logger interface {
	Errorf(string, ...interface{})
}

Logger is a simple interface for logging.

Path	Synopsis
example
basic