health

Documentation

Index

• type Check
  • func NewAPI(app string, instance string) *Check
  • func (h *Check) AddHandlersTo(router *mux.Router)
  • func (h *Check) RegisterHealthCondition(condition ConditionCheck)
  • func (h *Check) RegisterReadynessCondition(condition ConditionCheck)
• type Condition
• type ConditionCheck

Types

type Check

type Check struct {
	// contains filtered or unexported fields
}

Check implements the API for readiness and healt

func NewAPI

func NewAPI(app string, instance string) *Check

NewAPI creates a health check API

func (*Check) AddHandlersTo

func (h *Check) AddHandlersTo(router *mux.Router)

AddHandlersTo add the liveness, readiness and info handlers to the router

func (*Check) RegisterHealthCondition

func (h *Check) RegisterHealthCondition(condition ConditionCheck)

RegisterHealthCondition registers functions that determin whether the systeam is healthy

func (*Check) RegisterReadynessCondition

func (h *Check) RegisterReadynessCondition(condition ConditionCheck)

RegisterReadynessCondition registers functions that determin whether the systeam is ready to be used

type Condition

type Condition struct {
	Ready   bool   `json:"ready"`
	Message string `json:"message,omitempty"`
	Name    string `json:"name"`
}

Condition contains the information regarding the status of a piece of the System

type ConditionCheck

type ConditionCheck func() Condition

ConditionCheck defines the API for functions that check the condition of the system