mattermost

Documentation

Index

• Variables
• type AlertProvider
  • func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, ...) error
  • func (provider *AlertProvider) Validate() error
  • func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error
• type Attachment
• type Body
• type Config
  • func (cfg *Config) Merge(override *Config)
  • func (cfg *Config) Validate() error
• type Field
• type Override

Variables

var (
	ErrWebhookURLNotSet       = errors.New("webhook URL not set")
	ErrDuplicateGroupOverride = errors.New("duplicate group override")
)

Types

type AlertProvider

type AlertProvider struct {
	DefaultConfig Config `yaml:",inline"`

	// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
	DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"`

	// Overrides is a list of Override that may be prioritized over the default configuration
	Overrides []Override `yaml:"overrides,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using Mattermost

func (*AlertProvider) GetConfig

func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)

GetConfig returns the configuration for the provider with the overrides applied

func (*AlertProvider) GetDefaultAlert

func (provider *AlertProvider) GetDefaultAlert() *alert.Alert

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) Send

func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error

Send an alert using the provider

func (*AlertProvider) Validate

func (provider *AlertProvider) Validate() error

Validate the provider's configuration

func (*AlertProvider) ValidateOverrides

func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error

ValidateOverrides validates the alert's provider override and, if present, the group override

type Attachment

type Attachment struct {
	Title    string  `json:"title"`
	Fallback string  `json:"fallback"`
	Text     string  `json:"text"`
	Short    bool    `json:"short"`
	Color    string  `json:"color"`
	Fields   []Field `json:"fields"`
}

type Body

type Body struct {
	Channel     string       `json:"channel,omitempty"` // Optional channel override
	Text        string       `json:"text"`
	Username    string       `json:"username"`
	IconURL     string       `json:"icon_url"`
	Attachments []Attachment `json:"attachments"`
}

type Config

type Config struct {
	WebhookURL   string         `yaml:"webhook-url"`
	Channel      string         `yaml:"channel,omitempty"`
	ClientConfig *client.Config `yaml:"client,omitempty"`
}

func (*Config) Merge

func (cfg *Config) Merge(override *Config)

func (*Config) Validate

func (cfg *Config) Validate() error

type Field

type Field struct {
	Title string `json:"title"`
	Value string `json:"value"`
	Short bool   `json:"short"`
}

type Override

type Override struct {
	Group  string `yaml:"group"`
	Config `yaml:",inline"`
}

Override is a case under which the default integration is overridden