healthcheck

Documentation

Index

• func Configure(router gin.IRouter, client Client)
• func NewHandler(client Client) gin.HandlerFunc
• type Client

Functions

func Configure

func Configure(router gin.IRouter, client Client)

Configure configures router with a /healthz endpoint using a handler created with NewHandler.

func NewHandler

func NewHandler(client Client) gin.HandlerFunc

NewHandler returns a gin.HandlerFunc that provides a health check endpoint behavior. On each request it queries client.IsHealthy and returns a 200 if the backend is healthy, else a 500.

Types

type Client

type Client interface {
	// IsHealthy returns true if the backend is healthy, else false.
	IsHealthy(context.Context) bool
}

Client defines health check behavior for a service.