services

Documentation

Index

• func NewConsoleService(stdout io.Writer) *consoleService
• type BasicAuth
• type Destination
• type EmailNotification
  • func (n *EmailNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
• type EmailOptions
• type GrafanaAnnotation
• type GrafanaOptions
• type Header
• type Notification
  • func (n *Notification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
  • func (n *Notification) Preview() string
• type NotificationService
  • func NewEmailService(opts EmailOptions) NotificationService
  • func NewGrafanaService(opts GrafanaOptions) NotificationService
  • func NewOpsgenieService(opts OpsgenieOptions) NotificationService
  • func NewService(serviceType string, optsData []byte) (NotificationService, error)
  • func NewSlackService(opts SlackOptions) NotificationService
  • func NewTelegramService(opts TelegramOptions) NotificationService
  • func NewWebhookService(opts WebhookOptions) NotificationService
• type OpsgenieNotification
  • func (n *OpsgenieNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
• type OpsgenieOptions
• type SlackNotification
  • func (n *SlackNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
• type SlackOptions
• type TelegramOptions
• type Templater
• type TemplaterSource
• type WebhookNotification
• type WebhookNotifications
  • func (n WebhookNotifications) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
• type WebhookOptions

Functions

func NewConsoleService

func NewConsoleService(stdout io.Writer) *consoleService

Types

type BasicAuth

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

type Destination

type Destination struct {
	Service   string `json:"service"`
	Recipient string `json:"recipient"`
}

Destination holds notification destination details

type EmailNotification

type EmailNotification struct {
	Subject string `json:"subject,omitempty"`
	Body    string `json:"body,omitempty"`
}

func (*EmailNotification) GetTemplater

func (n *EmailNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

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 {
	Message  string                `json:"message,omitempty"`
	Email    *EmailNotification    `json:"email,omitempty"`
	Slack    *SlackNotification    `json:"slack,omitempty"`
	Webhook  WebhookNotifications  `json:"webhook,omitempty"`
	Opsgenie *OpsgenieNotification `json:"opsgenie,omitempty"`
}

func (*Notification) GetTemplater

func (n *Notification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

func (*Notification) Preview

func (n *Notification) Preview() string

type NotificationService

type NotificationService interface {
	Send(notification Notification, dest Destination) error
}

NotificationService defines notification service interface

func NewEmailService

func NewEmailService(opts EmailOptions) NotificationService

func NewGrafanaService

func NewGrafanaService(opts GrafanaOptions) NotificationService

func NewOpsgenieService

func NewOpsgenieService(opts OpsgenieOptions) NotificationService

func NewService

func NewService(serviceType string, optsData []byte) (NotificationService, error)

func NewSlackService

func NewSlackService(opts SlackOptions) NotificationService

func NewTelegramService

func NewTelegramService(opts TelegramOptions) NotificationService

func NewWebhookService

func NewWebhookService(opts WebhookOptions) NotificationService

type OpsgenieNotification

type OpsgenieNotification struct {
	Description string `json:"description"`
}

func (*OpsgenieNotification) GetTemplater

func (n *OpsgenieNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

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"`
}

func (*SlackNotification) GetTemplater

func (n *SlackNotification) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

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"`
	ApiURL             string   `json:"apiURL"`
}

type TelegramOptions

type TelegramOptions struct {
	Token string `json:"token"`
}

type Templater

type Templater func(notification *Notification, vars map[string]interface{}) error

type TemplaterSource

type TemplaterSource interface {
	GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)
}

type WebhookNotification

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

type WebhookNotifications

type WebhookNotifications map[string]WebhookNotification

func (WebhookNotifications) GetTemplater

func (n WebhookNotifications) GetTemplater(name string, f texttemplate.FuncMap) (Templater, error)

type WebhookOptions

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