checks

Documentation

Index

• type Checker
  • func (c *Checker) Check() *Report
  • func (c *Checker) Interval() time.Duration
  • func (c *Checker) String() string
• type Report
• type Status

Types

type Checker

type Checker struct {
	Name   string
	Config *config.CheckPlugin
}

Checker is the main interface of check monitoring. It invokes its given command and transforms the result to a Report to be sent to Mackerel periodically.

func (*Checker) Check

func (c *Checker) Check() *Report

Check invokes the command and transforms its result to a Report.

func (*Checker) Interval

func (c *Checker) Interval() time.Duration

Interval is the interval where the command is invoked.

func (*Checker) String

func (c *Checker) String() string

type Report

type Report struct {
	Name                 string
	Status               Status
	Message              string
	OccurredAt           time.Time
	NotificationInterval *int32
	MaxCheckAttempts     *int32
}

Report is what Checker produces by invoking its command.

type Status

type Status string

Status is a status that is produced by periodical checking. It is currently compatible with Nagios.

const (
	StatusUndefined Status = ""
	StatusOK        Status = "OK"
	StatusWarning   Status = "WARNING"
	StatusCritical  Status = "CRITICAL"
	StatusUnknown   Status = "UNKNOWN"
)

Current possible statuses, which is taken from command's exit code. the mapping is given as exitCodeToStatus.