healthz

Documentation

Index

• func InstallPathHandler(mux mux, path string, checks ...Checker)
• func RegisterDefaultChecks(mux mux, checks ...Checker)
• func RegisterPingEndpoint(mux mux)
• type Checker
  • func NamedCheck(name string, check func() error) Checker

Functions

func InstallPathHandler

func InstallPathHandler(mux mux, path string, checks ...Checker)

InstallPathHandler registers the healtz checks under path. This function can only be called once per mux/path combo.

func RegisterDefaultChecks

func RegisterDefaultChecks(mux mux, checks ...Checker)

RegisterDefaultChecks register the default checks along with the passed in checks.

func RegisterPingEndpoint

func RegisterPingEndpoint(mux mux)

RegisterPingEndpoint registers the ping endpoint to a serve mux.

Types

type Checker

type Checker interface {
	Name() string
	Check() error
}

Checker is a named healthz checker.

var PingHealthz Checker = ping{}

PingHealthz returns true automatically when checked.

func NamedCheck

func NamedCheck(name string, check func() error) Checker

NamedCheck returns a healthz checker for the given name and function.