healthz

Documentation

Index

• func RegisterHealthChecker(name string, fn CheckFn)
• func Setup(mux *xhttp.ServeMux)
• type CheckFn
• type Status

Functions

func RegisterHealthChecker

func RegisterHealthChecker(name string, fn CheckFn)

RegisterHealthChecker registers the given health checker function

func Setup

func Setup(mux *xhttp.ServeMux)

Setup prepares the given HTTP request multiplexer for serving healthz.

Types

type CheckFn

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

type Status

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
)