server

Documentation

Index

• Variables
• type Registration
  • func NewRegistration(name string, period time.Duration, ch checker.Checker) *Registration
• type Server
  • func NewServer() *Server
  • func (s *Server) Observe(names ...string) (*subscriber.Observer, error)
  • func (s *Server) Register(regs ...*Registration) error
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
  • func (s *Server) Subscribe(names ...string) (*subscriber.Subscriber, error)

Variables

var (
	// ErrProbeExists when we register the same probe.
	ErrProbeExists = errors.New("probe exists")

	// ErrNoRegistrations have been added.
	ErrNoRegistrations = errors.New("no registrations")

	// ErrRegistrationNotFound in register.
	ErrRegistrationNotFound = errors.New("registration not found")
)

Types

type Registration

type Registration struct {
	Name    string
	Period  time.Duration
	Checker checker.Checker
}

Registration for the server.

func NewRegistration

func NewRegistration(name string, period time.Duration, ch checker.Checker) *Registration

NewRegistration for server.

type Server

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

Server will maintain all the probes and start and stop them.

func NewServer

func NewServer() *Server

NewServer for health.

func (*Server) Observe

func (s *Server) Observe(names ...string) (*subscriber.Observer, error)

Observe the names of the probes.

func (*Server) Register

func (s *Server) Register(regs ...*Registration) error

Register all the registrations.

func (*Server) Start

func (s *Server) Start() error

Start the server.

func (*Server) Stop

func (s *Server) Stop() error

Stop the server.

func (*Server) Subscribe

func (s *Server) Subscribe(names ...string) (*subscriber.Subscriber, error)

Subscribe to the names of the probes.