healthz

package

v0.5.1 Latest Latest Go to latest Published: Mar 28, 2024 License: Apache-2.0 Imports: 6 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.

func RegisterHealthChecker(name string, fn CheckFn)

RegisterHealthChecker registers the given health checker function

func Setup(mux *xhttp.ServeMux)

Setup prepares the given HTTP request multiplexer for serving healthz.

type CheckFn func() (status Status, details error)

type Status int

Status describes the health of a component or the whole.

const (
	// just an example, we need to figure out what/if granularity makes any sense
	Healthy Status = iota
	Degraded
	NonFunctional
)