healthz

Documentation

Index

• Constants
• func HandlerFunc(h Manager) func(w http.ResponseWriter, r *http.Request)
• type Manager
  • func NewDefaultHealthz() Manager
  • func NewPeriodicHealthz(resetDuration time.Duration) Manager

Constants

const DefaultHealthManagerName = "default"

DefaultHealthManagerName is the name of the default health manager.

const PeriodicHealthManagerName = "periodic"

PeriodicHealthManagerName is the name of the periodic health manager.

Functions

func HandlerFunc

func HandlerFunc(h Manager) func(w http.ResponseWriter, r *http.Request)

HandlerFunc returns a HTTP handler that responds with 200 OK status code if the given health manager returns true, otherwise 500 Internal Server Error status code will be returned.

Types

type Manager

type Manager interface {
	// Name returns the name of the health manager.
	Name() string
	// Start starts the health manager.
	Start()
	// Stop stops the health manager.
	Stop()
	// Get returns the current health status.
	Get() bool
	// Set updates the current health status with the given value.
	Set(bool)
}

Manager is an interface for health managers.

func NewDefaultHealthz

func NewDefaultHealthz() Manager

NewDefaultHealthz returns a default health manager that stores the given health status and returns it.

func NewPeriodicHealthz

func NewPeriodicHealthz(resetDuration time.Duration) Manager

NewPeriodicHealthz returns a health manager that automatically sets the health status to false after the given reset duration. The timer is reset again when the health status is true (i.e., a running timer is reset and starts again from the beginning).