consul

Documentation

Index

• Constants
• type Check
• type CheckBlackListConfig
• type ChecksConfig
• type Consul
• type ConsulAlertClient
  • func NewClient(address, dc string) (*ConsulAlertClient, error)
  • func (c *ConsulAlertClient) CheckBlackList() *CheckBlackListConfig
  • func (c *ConsulAlertClient) CheckChangeThreshold() int
  • func (c *ConsulAlertClient) CheckStatus(node, serviceId, checkId string) (status, output string)
  • func (c *ConsulAlertClient) ChecksEnabled() bool
  • func (c *ConsulAlertClient) CustomNotifiers() []string
  • func (c *ConsulAlertClient) EmailConfig() *EmailNotifierConfig
  • func (c *ConsulAlertClient) EventHandlers(eventName string) []string
  • func (c *ConsulAlertClient) EventsEnabled() bool
  • func (c *ConsulAlertClient) InfluxdbConfig() *InfluxdbNotifierConfig
  • func (c *ConsulAlertClient) IsBlacklisted(check *Check) bool
  • func (c *ConsulAlertClient) LoadConfig()
  • func (c *ConsulAlertClient) LogConfig() *LogNotifierConfig
  • func (c *ConsulAlertClient) NewAlerts() []Check
  • func (c *ConsulAlertClient) PagerDutyConfig() *PagerDutyNotifierConfig
  • func (c *ConsulAlertClient) SlackConfig() *SlackNotifierConfig
  • func (c *ConsulAlertClient) UpdateCheckData()
• type ConsulAlertConfig
  • func DefaultAlertConfig() *ConsulAlertConfig
• type EmailNotifierConfig
• type Event
• type EventsConfig
• type InfluxdbNotifierConfig
• type LogNotifierConfig
• type NotifiersConfig
• type PagerDutyNotifierConfig
• type SlackNotifierConfig
• type Status

Constants

const (
	ConfigTypeBool = iota
	ConfigTypeString
	ConfigTypeInt
	ConfigTypeStrArray
)

Types

type Check

type Check struct {
	Node        string
	CheckID     string
	Name        string
	Status      string
	Notes       string
	Output      string
	ServiceID   string
	ServiceName string
}

type CheckBlackListConfig

type CheckBlackListConfig struct {
	Nodes  []string
	Checks []string
}

type ChecksConfig

type ChecksConfig struct {
	Enabled         bool
	ChangeThreshold int
	Blacklist       *CheckBlackListConfig
}

type Consul

type Consul interface {
	LoadConfig()

	EventsEnabled() bool
	ChecksEnabled() bool
	EventHandlers(eventName string) []string

	EmailConfig() *EmailNotifierConfig
	LogConfig() *LogNotifierConfig
	InfluxdbConfig() *InfluxdbNotifierConfig
	SlackConfig() *SlackNotifierConfig
	PagerDutyConfig() *PagerDutyNotifierConfig

	CheckChangeThreshold() int
	CheckBlackList() *CheckBlackListConfig
	UpdateCheckData()
	NewAlerts() []Check

	IsBlacklisted(check *Check) bool

	CustomNotifiers() []string

	CheckStatus(node, statusId, checkId string) (status, output string)
}

type ConsulAlertClient

type ConsulAlertClient struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(address, dc string) (*ConsulAlertClient, error)

func (*ConsulAlertClient) CheckBlackList

func (c *ConsulAlertClient) CheckBlackList() *CheckBlackListConfig

func (*ConsulAlertClient) CheckChangeThreshold

func (c *ConsulAlertClient) CheckChangeThreshold() int

func (*ConsulAlertClient) CheckStatus

func (c *ConsulAlertClient) CheckStatus(node, serviceId, checkId string) (status, output string)

func (*ConsulAlertClient) ChecksEnabled

func (c *ConsulAlertClient) ChecksEnabled() bool

func (*ConsulAlertClient) CustomNotifiers

func (c *ConsulAlertClient) CustomNotifiers() []string

func (*ConsulAlertClient) EmailConfig

func (c *ConsulAlertClient) EmailConfig() *EmailNotifierConfig

func (*ConsulAlertClient) EventHandlers

func (c *ConsulAlertClient) EventHandlers(eventName string) []string

func (*ConsulAlertClient) EventsEnabled

func (c *ConsulAlertClient) EventsEnabled() bool

func (*ConsulAlertClient) InfluxdbConfig

func (c *ConsulAlertClient) InfluxdbConfig() *InfluxdbNotifierConfig

func (*ConsulAlertClient) IsBlacklisted

func (c *ConsulAlertClient) IsBlacklisted(check *Check) bool

func (*ConsulAlertClient) LoadConfig

func (c *ConsulAlertClient) LoadConfig()

func (*ConsulAlertClient) LogConfig

func (c *ConsulAlertClient) LogConfig() *LogNotifierConfig

func (*ConsulAlertClient) NewAlerts

func (c *ConsulAlertClient) NewAlerts() []Check

func (*ConsulAlertClient) PagerDutyConfig

func (c *ConsulAlertClient) PagerDutyConfig() *PagerDutyNotifierConfig

func (*ConsulAlertClient) SlackConfig

func (c *ConsulAlertClient) SlackConfig() *SlackNotifierConfig

func (*ConsulAlertClient) UpdateCheckData

func (c *ConsulAlertClient) UpdateCheckData()

type ConsulAlertConfig

type ConsulAlertConfig struct {
	Checks    *ChecksConfig
	Events    *EventsConfig
	Notifiers *NotifiersConfig
}

func DefaultAlertConfig

func DefaultAlertConfig() *ConsulAlertConfig

type EmailNotifierConfig

type EmailNotifierConfig struct {
	ClusterName string
	Enabled     bool
	Url         string
	Port        int
	Username    string
	Password    string
	SenderAlias string
	SenderEmail string
	Receivers   []string
	Template    string
}

type Event

type Event struct {
	ID            string
	Name          string
	Payload       []byte
	NodeFilter    string
	ServiceFilter string
	TagFilter     string
	Version       uint
	LTime         uint
}

type EventsConfig

type EventsConfig struct {
	Enabled  bool
	Handlers []string
}

type InfluxdbNotifierConfig

type InfluxdbNotifierConfig struct {
	Enabled    bool
	Host       string
	Username   string
	Password   string
	Database   string
	SeriesName string
}

type LogNotifierConfig

type LogNotifierConfig struct {
	Enabled bool
	Path    string
}

type NotifiersConfig

type NotifiersConfig struct {
	Email     *EmailNotifierConfig
	Log       *LogNotifierConfig
	Influxdb  *InfluxdbNotifierConfig
	Slack     *SlackNotifierConfig
	PagerDuty *PagerDutyNotifierConfig
	Custom    []string
}

type PagerDutyNotifierConfig

type PagerDutyNotifierConfig struct {
	Enabled    bool
	ServiceKey string
	ClientName string
	ClientUrl  string
}

type SlackNotifierConfig

type SlackNotifierConfig struct {
	Enabled     bool
	ClusterName string
	Team        string
	Token       string
	Channel     string
	Username    string
	IconUrl     string
	IconEmoji   string
}

type Status

type Status struct {
	Current          string
	CurrentTimestamp time.Time
	Pending          string
	PendingTimestamp time.Time
	HealthCheck      *Check
	ForNotification  bool
}