monitoring

Documentation

Index

• type Alert
• type Module
• type ModuleReport
  • func NewReport(name string, t time.Time, cmd string) ModuleReport
  • func (r *ModuleReport) AddAlert(alert string)
  • func (r *ModuleReport) AddWarning(warn string)
• type Warning

Types

type Alert

type Alert string

type Module

type Module interface {
	GetDescription() string
	IsEnabled() bool
	Run() ([]*ModuleReport, error)
}

type ModuleReport

type ModuleReport struct {
	Name            string                 `json:"name"`
	Timestamp       common.Timestamp       `json:"timestamp"`
	ExecutedCommand string                 `json:"command executed,omitempty"`
	Alerts          []Alert                `json:"alerts"`
	Warnings        []Warning              `json:"warnings"`
	Message         string                 `json:"message,omitempty"`
	Measurements    map[string]interface{} `json:"measurements,omitempty"`
}

ModuleReport provides the results of Module run Do not use the struct directly, use NewReport() to initialize it

func NewReport

func NewReport(name string, t time.Time, cmd string) ModuleReport

func (*ModuleReport) AddAlert

func (r *ModuleReport) AddAlert(alert string)

func (*ModuleReport) AddWarning

func (r *ModuleReport) AddWarning(warn string)

type Warning

type Warning string