gotify

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 Body
• type Config
  • func (cfg *Config) Merge(override *Config)
  • func (cfg *Config) Validate() error

Constants

const DefaultPriority = 5

Variables

var (
	ErrServerURLNotSet = errors.New("server URL not set")
	ErrTokenNotSet     = errors.New("token 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"`
}

AlertProvider is the configuration necessary for sending an alert using Gotify

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 Body

type Body struct {
	Message  string `json:"message"`
	Title    string `json:"title"`
	Priority int    `json:"priority"`
}

type Config

type Config struct {
	ServerURL string `yaml:"server-url"`         // URL of the Gotify server
	Token     string `yaml:"token"`              // Token to use when sending a message to the Gotify server
	Priority  int    `yaml:"priority,omitempty"` // Priority of the message. Defaults to DefaultPriority.
	Title     string `yaml:"title,omitempty"`    // Title of the message that will be sent
}

func (*Config) Merge

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

func (*Config) Validate

func (cfg *Config) Validate() error