health

Documentation

Index

• Constants
• type Config
  • func (c *Config) Hydrate(cfg service.Config) error
  • func (c *Config) Valid() error
• type Service
  • func (s *Service) Init(cfg *Config, r *rrhttp.Service, log *logrus.Logger) (bool, error)
  • func (s *Service) Serve() error
  • func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Service) Stop()

Constants

const (
	// ID declares public service name.
	ID = "health"
)

Types

type Config

type Config struct {
	// Address to listen on
	Address string
}

Config configures the health service

func (*Config) Hydrate

func (c *Config) Hydrate(cfg service.Config) error

Hydrate the config

func (*Config) Valid

func (c *Config) Valid() error

Valid validates the configuration.

type Service

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

Service to serve an endpoint for checking the health of the worker pool

func (*Service) Init

func (s *Service) Init(cfg *Config, r *rrhttp.Service, log *logrus.Logger) (bool, error)

Init health service

func (*Service) Serve

func (s *Service) Serve() error

Serve the health endpoint

func (*Service) ServeHTTP

func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP returns the health of the pool of workers

func (*Service) Stop

func (s *Service) Stop()

Stop the health endpoint