healthcheck

Documentation

Index

• type AggregateHealthCheck
  • func NewHealthCheck(logger *zerolog.Logger, interval time.Duration, services []HealthCheck) *AggregateHealthCheck
  • func (c *AggregateHealthCheck) AnyServiceUnhealthy() bool
  • func (c *AggregateHealthCheck) CheckForFailures() error
• type ClientHealthChecker
  • func NewClientHealthChecker(port string, f func() error) *ClientHealthChecker
  • func (s *ClientHealthChecker) StartProbes()
• type HealthCheck
• type HealthChecker

Types

type AggregateHealthCheck

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

func NewHealthCheck

func NewHealthCheck(logger *zerolog.Logger, interval time.Duration, services []HealthCheck) *AggregateHealthCheck

func (*AggregateHealthCheck) AnyServiceUnhealthy

func (c *AggregateHealthCheck) AnyServiceUnhealthy() bool

func (*AggregateHealthCheck) CheckForFailures

func (c *AggregateHealthCheck) CheckForFailures() error

type ClientHealthChecker

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

ClientHealthChecker contains the port and check function callback

func NewClientHealthChecker

func NewClientHealthChecker(port string, f func() error) *ClientHealthChecker

NewClientHealthChecker function will return new ClientHealthChecker struct with specified port and checkFunction

func (*ClientHealthChecker) StartProbes

func (s *ClientHealthChecker) StartProbes()

StartProbes will initilize http endpoint for(/health) check

type HealthCheck

type HealthCheck struct {
	Ping        func() error
	ServiceName string
	// contains filtered or unexported fields
}

type HealthChecker

type HealthChecker interface {
	// HealthCheck checks whether the underlying connection is still ongoing.
	HealthCheck() error
}