healthz

package

v0.0.0-...-34c5bf1 Latest Latest Go to latest Published: Dec 7, 2020 License: MIT 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

Repository

github.com/jakewright/home-automation

Documentation ¶

Index ¶

func RegisterCheck(name string, check HealthCheck)
func Status(ctx context.Context) map[string]error
type HealthCheck

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RegisterCheck ¶

func RegisterCheck(name string, check HealthCheck)

RegisterCheck adds a new check to the global register. If a check with the given name already exists, the function will panic.

func Status ¶

func Status(ctx context.Context) map[string]error

Status runs all of the currently registered health checks and returns a map of the results.

Types ¶

type HealthCheck ¶

type HealthCheck func(ctx context.Context) error

HealthCheck is a function that returns an error if a component is unhealthy. The application's overall health depends on the set of registered HealthChecks returning nil errors.

Source Files ¶

View all Source files

healthz.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL