health

Documentation

Index

• func Liveness(cf ...CheckFunc) http.Handler
• func Readiness() http.Handler
• func Ready()
• type CheckFunc

Functions

func Liveness

func Liveness(cf ...CheckFunc) http.Handler

Liveness returns an HTTP handler for checking the health of the service.

func Readiness

func Readiness() http.Handler

Readiness returns an HTTP handler for checking Readiness state. Will return 503 untill Ready() is called

func Ready

func Ready()

Ready marks the service as ready to receive traffic.

Types

type CheckFunc

type CheckFunc func(context.Context) error

CheckFunc function signature for health checks.