healthcheck

Documentation

Index

• type Checker
• type CheckerFunc
  • func (f CheckerFunc) Check(ctx context.Context) error
• type HealthChecker
  • func NewHealthChecker(serverType string) *HealthChecker
  • func (h *HealthChecker) AddHealthCheck(name string, f Checker)
  • func (h *HealthChecker) LivenessHandler() http.Handler
  • func (h *HealthChecker) ReadinessHandler() http.Handler
  • func (h *HealthChecker) RegisterShutdownFunction(f ShutDownFunc)
  • func (h *HealthChecker) WaitForGracefulShutdown()
• type ShutDownFunc

Types

type Checker

type Checker interface {
	Check(ctx context.Context) error
}

type CheckerFunc

type CheckerFunc func(ctx context.Context) error

func (CheckerFunc) Check

func (f CheckerFunc) Check(ctx context.Context) error

type HealthChecker

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

func NewHealthChecker

func NewHealthChecker(serverType string) *HealthChecker

func (*HealthChecker) AddHealthCheck

func (h *HealthChecker) AddHealthCheck(name string, f Checker)

func (*HealthChecker) LivenessHandler

func (h *HealthChecker) LivenessHandler() http.Handler

func (*HealthChecker) ReadinessHandler

func (h *HealthChecker) ReadinessHandler() http.Handler

func (*HealthChecker) RegisterShutdownFunction

func (h *HealthChecker) RegisterShutdownFunction(f ShutDownFunc)

func (*HealthChecker) WaitForGracefulShutdown

func (h *HealthChecker) WaitForGracefulShutdown()

type ShutDownFunc

type ShutDownFunc func(ctx context.Context) error