notifiers

Documentation

Index

• func GetAll(config Config) map[string]Notifier
• type BasicAuth
• type Config
• type EmailOptions
• type GrafanaAnnotation
• type GrafanaOptions
• type Header
• type Notification
• type Notifier
  • func NewEmailNotifier(opts EmailOptions) Notifier
  • func NewGrafanaNotifier(opts GrafanaOptions) Notifier
  • func NewOpsgenieNotifier(opts OpsgenieOptions) Notifier
  • func NewSlackNotifier(opts SlackOptions) Notifier
  • func NewWebhookNotifier(opts WebhookOptions) Notifier
• type OpsgenieOptions
• type SlackNotification
• type SlackOptions
• type SlackSpecific
• type WebhookNotification
• type WebhookOptions
• type WebhookSettings

Functions

func GetAll

func GetAll(config Config) map[string]Notifier

Types

type BasicAuth

type BasicAuth struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type Config

type Config struct {
	Email    *EmailOptions    `json:"email"`
	Slack    *SlackOptions    `json:"slack"`
	Opsgenie *OpsgenieOptions `json:"opsgenie"`
	Grafana  *GrafanaOptions  `json:"grafana"`
	Webhook  *WebhookOptions  `json:"webhook"`
}

type EmailOptions

type EmailOptions struct {
	Host               string `json:"host"`
	Port               int    `json:"port"`
	InsecureSkipVerify bool   `json:"insecure_skip_verify"`
	Username           string `json:"username"`
	Password           string `json:"password"`
	From               string `json:"from"`
}

type GrafanaAnnotation

type GrafanaAnnotation struct {
	Time     int64    `json:"time"` // unix ts in ms
	IsRegion bool     `json:"isRegion"`
	Tags     []string `json:"tags"`
	Text     string   `json:"text"`
}

type GrafanaOptions

type GrafanaOptions struct {
	ApiUrl             string `json:"apiUrl"`
	ApiKey             string `json:"apiKey"`
	InsecureSkipVerify bool   `json:"insecureSkipVerify"`
}

type Header

type Header struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type Notification

type Notification struct {
	Title   string                         `json:"title,omitempty"`
	Body    string                         `json:"body,omitempty"`
	Slack   *SlackNotification             `json:"slack,omitempty"`
	Webhook map[string]WebhookNotification `json:"webhook,omitempty" patchStrategy:"replace"`
}

type Notifier

type Notifier interface {
	Send(notification Notification, recipient string) error
}

func NewEmailNotifier

func NewEmailNotifier(opts EmailOptions) Notifier

func NewGrafanaNotifier

func NewGrafanaNotifier(opts GrafanaOptions) Notifier

func NewOpsgenieNotifier

func NewOpsgenieNotifier(opts OpsgenieOptions) Notifier

func NewSlackNotifier

func NewSlackNotifier(opts SlackOptions) Notifier

func NewWebhookNotifier

func NewWebhookNotifier(opts WebhookOptions) Notifier

type OpsgenieOptions

type OpsgenieOptions struct {
	ApiUrl  string            `json:"apiUrl"`
	ApiKeys map[string]string `json:"apiKeys"`
}

type SlackNotification

type SlackNotification struct {
	Attachments string `json:"attachments,omitempty"`
	Blocks      string `json:"blocks,omitempty"`
}

type SlackOptions

type SlackOptions struct {
	Username           string   `json:"username"`
	Icon               string   `json:"icon"`
	Token              string   `json:"token"`
	SigningSecret      string   `json:"signingSecret"`
	Channels           []string `json:"channels"`
	InsecureSkipVerify bool     `json:"insecureSkipVerify"`
}

type SlackSpecific

type SlackSpecific struct {
	Attachments string `json:"attachments,omitempty"`
	Blocks      string `json:"blocks,omitempty"`
}

type WebhookNotification

type WebhookNotification struct {
	Method string `json:"method"`
	Body   string `json:"body"`
	Path   string `json:"path"`
}

type WebhookOptions

type WebhookOptions []WebhookSettings

WebhookOptions holds list of configured webhooks settings

type WebhookSettings

type WebhookSettings struct {
	Name      string     `json:"name"`
	URL       string     `json:"url"`
	Headers   []Header   `json:"headers"`
	BasicAuth *BasicAuth `json:"basicAuth"`
}