alert

Documentation

Index

• Constants
• func DispatchAlert(a Alert) error
• func SendEmail(config map[string]interface{}, vars TemplateVars) error
• func SendHTTP(config map[string]interface{}, vars TemplateVars) error
• func SendPagerDuty(config map[string]interface{}, vars TemplateVars) error
• func SendSlack(config map[string]interface{}, vars TemplateVars) error
• func SendTwilio(config map[string]interface{}, vars TemplateVars) error
• type Alert
• type TemplateVars

Constants

const (
	AlertEmail     = "email"
	AlertSlack     = "slack"
	AlertHTTP      = "http"
	AlertPagerDuty = "pagerduty"
	AlertTwilio    = "twilio"
)

alertType enum

Functions

func DispatchAlert

func DispatchAlert(a Alert) error

DispatchAlert actually sends the Alert based on configuration and business rules

func SendEmail

func SendEmail(config map[string]interface{}, vars TemplateVars) error

SendEmail dispatches an alert by e-mail

func SendHTTP

func SendHTTP(config map[string]interface{}, vars TemplateVars) error

SendHTTP posts an alert on a custom HTTP endpoint

func SendPagerDuty

func SendPagerDuty(config map[string]interface{}, vars TemplateVars) error

SendPagerDuty post a message on a PagerDuty webhook

func SendSlack

func SendSlack(config map[string]interface{}, vars TemplateVars) error

SendSlack post a message on a Slack webhook

func SendTwilio

func SendTwilio(config map[string]interface{}, vars TemplateVars) error

SendTwilio post a message on a Twilio webhook

Types

type Alert

type Alert struct {
	ChannelType   string
	ChannelConfig map[string]interface{}

	Vars TemplateVars
}

Alert is a description of an alert to dispatch. It contains the details about the channel to dispatch the alert on and the variables to inject into the message template.

type TemplateVars

type TemplateVars struct {
	Title, Message       string
	Target, Agent, Probe string
	State                string
	Reason               string
	Critical, Warning    bool
}

TemplateVars is the set of variables to inject into the message template for a channel type.