core

Documentation

Index

• type Check
• type MonitorConfiguration
• type ServiceStatus
• type Status
  • func (i Status) String() string

Types

type Check

type Check interface {
	// Name of the check
	Name() string
	// Description is the description of the check
	Description() string
	// Version of the monitor
	Version() string
	// Check the status of a service
	Perform() (Status, error)
	// Watch the status of a service continously
	Watch(update chan<- *ServiceStatus, stop <-chan bool, wg *sync.WaitGroup) error
	// Config is the configuration used for the monitor
	Config() MonitorConfiguration
}

Check is a monitoring unit that checks a service

type MonitorConfiguration

type MonitorConfiguration interface {
	// Validate validates the configuration
	Validate() []error
}

MonitorConfiguration is a configuration for a monitor check

type ServiceStatus

type ServiceStatus struct {
	Err    error
	Status Status
	Check  Check
}

type Status

type Status int

const (
	StatusUp Status = iota
	StatusTransitioningUp
	StatusTransitioningDown
	StatusDown
	StatusUnknown
)

func (Status) String

func (i Status) String() string