custom

Documentation

Index

• Variables
• type AlertProvider
  • func (provider *AlertProvider) GetAlertStatePlaceholderValue(cfg *Config, resolved bool) string
  • 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 Config
  • func (cfg *Config) Merge(override *Config)
  • func (cfg *Config) Validate() error
• type Override

Variables

var (
	ErrURLNotSet = errors.New("url not set")
)

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 a custom HTTP request Technically, all alert providers should be reachable using the custom alert provider

func (*AlertProvider) GetAlertStatePlaceholderValue

func (provider *AlertProvider) GetAlertStatePlaceholderValue(cfg *Config, resolved bool) string

GetAlertStatePlaceholderValue returns the Placeholder value for ALERT_TRIGGERED_OR_RESOLVED if configured

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

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 Config

type Config struct {
	URL          string                       `yaml:"url"`
	Method       string                       `yaml:"method,omitempty"`
	Body         string                       `yaml:"body,omitempty"`
	Headers      map[string]string            `yaml:"headers,omitempty"`
	Placeholders map[string]map[string]string `yaml:"placeholders,omitempty"`

	// ClientConfig is the configuration of the client used to communicate with the provider's target
	ClientConfig *client.Config `yaml:"client,omitempty"`
}

func (*Config) Merge

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

func (*Config) Validate

func (cfg *Config) Validate() error

type Override

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

Override is a case under which the default integration is overridden