Documentation ¶
Index ¶
- Constants
- 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 Config
- type Override
Constants ¶
View Source
const (
CharSet = "UTF-8"
)
Variables ¶
Functions ¶
This section is empty.
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 AWS Simple Email Service
func (*AlertProvider) GetConfig ¶ added in v5.14.0
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 ¶ added in v5.14.0
func (provider *AlertProvider) Validate() error
Validate the provider's configuration
func (*AlertProvider) ValidateOverrides ¶ added in v5.14.0
func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error
ValidateOverrides validates the alert's provider override and, if present, the group override
Click to show internal directories.
Click to hide internal directories.