health

Documentation

Index

• func RegisterCheck(name string, check SubsystemCheck)
• func SetParentLogger(l hclog.Logger)
• type SubsystemCheck
• type SubsystemStatus
  • func (s SubsystemStatus) Proto() *pb.SubSystemStatus
  • func (s SubsystemStatus) String() string
• type SystemStatus
  • func Check() SystemStatus
  • func (s SystemStatus) Proto() *pb.ServerStatus
  • func (s SystemStatus) String() string

Functions

func RegisterCheck

func RegisterCheck(name string, check SubsystemCheck)

RegisterCheck allows an interested subsystem to register a check that will be called when health status is requested.

func SetParentLogger

func SetParentLogger(l hclog.Logger)

SetParentLogger sets the parent logger for this instance.

Types

type SubsystemCheck

type SubsystemCheck func() SubsystemStatus

A SubsystemCheck is a function that is supplied by a particular subsystem of the server which then provides informatino about that subsystem during a status poll.

type SubsystemStatus

type SubsystemStatus struct {
	OK     bool
	Name   string
	Status string
}

SubsystemStatus contains the information needed to be returned by callback checks to determine worthyness to serve.

func (SubsystemStatus) Proto

func (s SubsystemStatus) Proto() *pb.SubSystemStatus

Proto returns the proto version of the subsystem status.

func (SubsystemStatus) String

func (s SubsystemStatus) String() string

String provides the string representation of the SubsystemStatus

type SystemStatus

type SystemStatus struct {
	OK           bool
	FirstFailure SubsystemStatus
	Subsystems   []SubsystemStatus
}

A SystemStatus is returned containing the status of the entire server, and in the event of a failure will have the FirstFailure encountered called out.

func Check

func Check() SystemStatus

Check runs all the health checks and returns the aggregate status to the caller.

func (SystemStatus) Proto

func (s SystemStatus) Proto() *pb.ServerStatus

Proto returns the complete system status

func (SystemStatus) String

func (s SystemStatus) String() string

String provides the string representation of the SystemStatus