health

Documentation

Index

• func HealthzHandler(w http.ResponseWriter, r *http.Request)
• func HealthzStatus() int
• func HealthzStatusHandler(w http.ResponseWriter, r *http.Request)
• func ReadinessHandler(w http.ResponseWriter, r *http.Request)
• func ReadinessStatus() int
• func SetHealthzStatus(status int)
• func SetReadinessStatus(status int)

Functions

func HealthzHandler

func HealthzHandler(w http.ResponseWriter, r *http.Request)

HealthzHandler responds to health check requests.

func HealthzStatus

func HealthzStatus() int

HealthzStatus returns the current health status of the application.

func HealthzStatusHandler

func HealthzStatusHandler(w http.ResponseWriter, r *http.Request)

HealthzStatusHandler is an HTTP handler for toggling the health status of the application. In other words, if the current status is Okay then hitting this endpoint will change the status to Unavailable...and vice versa.

func ReadinessHandler

func ReadinessHandler(w http.ResponseWriter, r *http.Request)

ReadinessHandler responds to readiness check requests.

func ReadinessStatus

func ReadinessStatus() int

ReadinessStatus returns the current readiness status of the application.

func SetHealthzStatus

func SetHealthzStatus(status int)

SetHealthzStatus sets the current health status of the application.

func SetReadinessStatus

func SetReadinessStatus(status int)

SetReadinessStatus sets the current readiness status of the application.