opsgenie

Documentation

Index

• type AlertProvider
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, ...) error

Types

type AlertProvider

type AlertProvider struct {
	// APIKey to use for
	APIKey string `yaml:"api-key"`

	// Priority to be used in Opsgenie alert payload
	//
	// default: P1
	Priority string `yaml:"priority"`

	// Source define source to be used in Opsgenie alert payload
	//
	// default: gatus
	Source string `yaml:"source"`

	// EntityPrefix is a prefix to be used in entity argument in Opsgenie alert payload
	//
	// default: gatus-
	EntityPrefix string `yaml:"entity-prefix"`

	//AliasPrefix is a prefix to be used in alias argument in Opsgenie alert payload
	//
	// default: gatus-healthcheck-
	AliasPrefix string `yaml:"alias-prefix"`

	// Tags to be used in Opsgenie alert payload
	//
	// default: []
	Tags []string `yaml:"tags"`

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

func (*AlertProvider) GetDefaultAlert

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

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

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

Send an alert using the provider

Relevant: https://docs.opsgenie.com/docs/alert-api