monitors

Documentation

Index

• Constants
• func SetupMonitors(c config.Config)
• type Monitor

Constants

const (
	StatusUp   monitorStatus = "up"
	StatusDown monitorStatus = "down"
)

Functions

func SetupMonitors

func SetupMonitors(c config.Config)

Schedule monitors to run in background

Types

type Monitor

type Monitor interface {
	// Name of this monitor (user defined in config)
	Name() string
	// Type of this monitor
	Type() string
	// Resolved host of this monitor
	HostURL() string
	// Key used to identify this monitor on the uptime host
	Key() string
	// Interval in seconds this monitor runs
	Interval() int

	// Run a single iteration of this monitor (periodically called)
	Run() (status monitorStatus, message string, pingMs int, err error)
}