health

Documentation

Index

• type Health
  • func Use(e *echo.Echo, url string) *Health
  • func (health *Health) HandlerFunc() func(c echo.Context) error
  • func (health *Health) SetServingStatus(status healthpb.HealthCheckResponse_ServingStatus)

Types

type Health

type Health struct {
	// contains filtered or unexported fields
}

Health implements a basic health check for echo by wrapping the generic health check

func Use

func Use(e *echo.Echo, url string) *Health

Use registers a new health check handler and returns it

func (*Health) HandlerFunc

func (health *Health) HandlerFunc() func(c echo.Context) error

HandlerFunc returns an echo `HandlerFunc` for this health check implements https://pkg.go.dev/github.com/labstack/echo/v4#HandlerFunc

func (*Health) SetServingStatus

func (health *Health) SetServingStatus(status healthpb.HealthCheckResponse_ServingStatus)

SetServingStatus updates the serving status