notify

Documentation

Index

• func FormatShortMessage(event events.Event) (msg string)
• type Discord
  • func (d *Discord) SendEvent(event events.Event) (err error)
  • func (d *Discord) SendMessage(msg string) error
• type ElasticSearch
  • func (e *ElasticSearch) SendEvent(event events.Event) (err error)
  • func (e *ElasticSearch) SendMessage(msg string) error
• type EventMeta
• type EventStatus
• type Mattermost
  • func (m *Mattermost) SendEvent(event events.Event) error
  • func (m *Mattermost) SendMessage(msg string) error
• type Notifier
  • func ListNotifiers(conf config.CommunicationsConfig) []Notifier
  • func NewDiscord(c config.Discord) Notifier
  • func NewElasticSearch(c config.ElasticSearch) (Notifier, error)
  • func NewMattermost(c config.Mattermost) (Notifier, error)
  • func NewSlack(c config.Slack) Notifier
  • func NewWebhook(c config.CommunicationsConfig) Notifier
• type Slack
  • func (s *Slack) SendEvent(event events.Event) error
  • func (s *Slack) SendMessage(msg string) error
• type Webhook
  • func (w *Webhook) PostWebhook(jsonPayload *WebhookPayload) error
  • func (w *Webhook) SendEvent(event events.Event) (err error)
  • func (w *Webhook) SendMessage(msg string) error
• type WebhookPayload

Functions

func FormatShortMessage

func FormatShortMessage(event events.Event) (msg string)

FormatShortMessage prepares message in short event format

Types

type Discord

type Discord struct {
	Token     string
	ChannelID string
	NotifType config.NotifType
}

Discord contains URL and ClusterName

func (*Discord) SendEvent

func (d *Discord) SendEvent(event events.Event) (err error)

SendEvent sends event notification to Discord Channel

func (*Discord) SendMessage

func (d *Discord) SendMessage(msg string) error

SendMessage sends message to Discord Channel

type ElasticSearch

type ElasticSearch struct {
	ELSClient     *elastic.Client
	Server        string
	SkipTLSVerify bool
	Index         string
	Shards        int
	Replicas      int
	Type          string
}

ElasticSearch contains auth cred and index setting

func (*ElasticSearch) SendEvent

func (e *ElasticSearch) SendEvent(event events.Event) (err error)

SendEvent sends event notification to slack

func (*ElasticSearch) SendMessage

func (e *ElasticSearch) SendMessage(msg string) error

SendMessage sends message to slack channel

type EventMeta

type EventMeta struct {
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
	Cluster   string `json:"cluster,omitempty"`
}

EventMeta contains the meta data about the event occurred

type EventStatus

type EventStatus struct {
	Type     config.EventType `json:"type"`
	Level    config.Level     `json:"level"`
	Reason   string           `json:"reason,omitempty"`
	Error    string           `json:"error,omitempty"`
	Messages []string         `json:"messages,omitempty"`
}

EventStatus contains the status about the event occurred

type Mattermost

type Mattermost struct {
	Client    *model.Client4
	Channel   string
	NotifType config.NotifType
}

Mattermost contains server URL and token

func (*Mattermost) SendEvent

func (m *Mattermost) SendEvent(event events.Event) error

SendEvent sends event notification to Mattermost

func (*Mattermost) SendMessage

func (m *Mattermost) SendMessage(msg string) error

SendMessage sends message to Mattermost channel

type Notifier

type Notifier interface {
	SendEvent(events.Event) error
	SendMessage(string) error
}

Notifier to send event notification on the communication channels

func ListNotifiers

func ListNotifiers(conf config.CommunicationsConfig) []Notifier

ListNotifiers returns list of configured notifiers

func NewDiscord

func NewDiscord(c config.Discord) Notifier

NewDiscord returns new Discord object

func NewElasticSearch

func NewElasticSearch(c config.ElasticSearch) (Notifier, error)

NewElasticSearch returns new ElasticSearch object

func NewMattermost

func NewMattermost(c config.Mattermost) (Notifier, error)

NewMattermost returns new Mattermost object

func NewSlack

func NewSlack(c config.Slack) Notifier

NewSlack returns new Slack object

func NewWebhook

func NewWebhook(c config.CommunicationsConfig) Notifier

NewWebhook returns new Webhook object

type Slack

type Slack struct {
	Channel   string
	NotifType config.NotifType
	Client    *slack.Client
}

Slack contains Token for authentication with slack and Channel name to send notification to

func (*Slack) SendEvent

func (s *Slack) SendEvent(event events.Event) error

SendEvent sends event notification to slack

func (*Slack) SendMessage

func (s *Slack) SendMessage(msg string) error

SendMessage sends message to slack channel

type Webhook

type Webhook struct {
	URL string
}

Webhook contains URL

func (*Webhook) PostWebhook

func (w *Webhook) PostWebhook(jsonPayload *WebhookPayload) error

PostWebhook posts webhook to listener

func (*Webhook) SendEvent

func (w *Webhook) SendEvent(event events.Event) (err error)

SendEvent sends event notification to Webhook url

func (*Webhook) SendMessage

func (w *Webhook) SendMessage(msg string) error

SendMessage sends message to Webhook url

type WebhookPayload

type WebhookPayload struct {
	EventMeta       EventMeta   `json:"meta"`
	EventStatus     EventStatus `json:"status"`
	EventSummary    string      `json:"summary"`
	TimeStamp       time.Time   `json:"timestamp"`
	Recommendations []string    `json:"recommendations,omitempty"`
	Warnings        []string    `json:"warnings,omitempty"`
}

WebhookPayload contains json payload to be sent to webhook url