health

Documentation

Index

• func AddProbe(probe Probe)
• func CreateHttpHandler(healthResponse string) http.HandlerFunc
• type Probe
  • func NewHealthManager(name string) Probe

Functions

func AddProbe

func AddProbe(probe Probe)

AddProbe add components probe to global comboHealthManager.

func CreateHttpHandler

func CreateHttpHandler(healthResponse string) http.HandlerFunc

CreateHttpHandler create health http handler base on given probe.

Types

type Probe

type Probe interface {
	// MarkReady sets a ready state for the endpoint handlers.
	MarkReady()
	// MarkNotReady sets a not ready state for the endpoint handlers.
	MarkNotReady()
	// IsReady return inner state for the component.
	IsReady() bool
	// Name return probe name identifier
	Name() string
}

Probe represents readiness status of a given component.

func NewHealthManager

func NewHealthManager(name string) Probe

NewHealthManager returns a new healthManager.