healthcheck

Documentation

Index

• type Check
  • func DNSResolveCheck(host string, timeout time.Duration) Check
  • func DatabasePingCheck(database *sql.DB, timeout time.Duration) Check
  • func GoroutineCountCheck(threshold int) Check
  • func HTTPGetCheck(url string, timeout time.Duration) Check
  • func TCPDialCheck(addr string, timeout time.Duration) Check
• type Handler
  • func GetHealthHandler() Handler

Types

type Check

type Check func() error

Check is a health/readiness check.

func DNSResolveCheck

func DNSResolveCheck(host string, timeout time.Duration) Check

DNSResolveCheck returns a Check that makes sure the provided host can resolve to at least one IP address within the specified timeout.

func DatabasePingCheck

func DatabasePingCheck(database *sql.DB, timeout time.Duration) Check

DatabasePingCheck returns a Check that validates connectivity to a database/sql.DB using Ping().

func GoroutineCountCheck

func GoroutineCountCheck(threshold int) Check

GoroutineCountCheck returns a Check that fails if too many goroutines are running (which could indicate a resource leak).

func HTTPGetCheck

func HTTPGetCheck(url string, timeout time.Duration) Check

HTTPGetCheck returns a Check that performs an HTTP GET request against the specified URL. The check fails if the response times out or returns a non-200 status code.

func TCPDialCheck

func TCPDialCheck(addr string, timeout time.Duration) Check

TCPDialCheck returns a Check that checks TCP connectivity to the provided endpoint.

type Handler

type Handler interface {
	Routes() []*router.Route
	AddLivenessCheck(name string, check Check)
	AddReadinessCheck(name string, check Check)
	LiveEndpoint(ctx *gin.Context)
	ReadyEndpoint(ctx *gin.Context)
	RemoveLivenessCheck(name string)
	RemoveReadinessCheck(name string)
}

Handler is an endpoints with additional methods that register health and readiness checks. It handles handle "/live" and "/ready" HTTP endpoints.

func GetHealthHandler

func GetHealthHandler() Handler

GetHealthHandler ...