health

Documentation

Index

• func GetLiveness(response http.ResponseWriter, req *http.Request)
• func GetReadiness(response http.ResponseWriter, req *http.Request)
• func HeadLiveness(response http.ResponseWriter, req *http.Request)
• func HeadReadiness(response http.ResponseWriter, req *http.Request)
• func InitHealthSystem(config CheckConfig, tracer opentracing.Tracer)
• func Routes() *chi.Mux
• type CheckConfig
• type Msg

Functions

func GetLiveness

func GetLiveness(response http.ResponseWriter, req *http.Request)

GetLiveness liveness probe

func GetReadiness

func GetReadiness(response http.ResponseWriter, req *http.Request)

GetReadiness is this service ready for taking requests, e.g. formaly known as health checks

func HeadLiveness

func HeadLiveness(response http.ResponseWriter, req *http.Request)

HeadLiveness liveness probe

func HeadReadiness

func HeadReadiness(response http.ResponseWriter, req *http.Request)

HeadReadiness is this service ready for taking requests, e.g. formaly known as health checks

func InitHealthSystem

func InitHealthSystem(config CheckConfig, tracer opentracing.Tracer)

InitHealthSystem initialise the complete health system

func Routes

func Routes() *chi.Mux

Types

type CheckConfig

type CheckConfig struct {
	Period int
}

CheckConfig configuration for the healthcheck system

type Msg

type Msg struct {
	Message   string `json:"message"`
	LastCheck string `json:"lastCheck,omitempty"`
}

Msg a health message