notifier

Documentation

Index

• type Notifier
  • func New(o *Options) *Notifier
  • func (n *Notifier) Alertmanagers() []string
  • func (n *Notifier) ApplyConfig(conf *config.Config) error
  • func (n *Notifier) Collect(ch chan<- prometheus.Metric)
  • func (n *Notifier) Describe(ch chan<- *prometheus.Desc)
  • func (n *Notifier) Run()
  • func (n *Notifier) Send(alerts ...*model.Alert)
  • func (n *Notifier) Stop()
• type Options

Types

type Notifier

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier is responsible for dispatching alert notifications to an alert manager service.

func New

func New(o *Options) *Notifier

New constructs a new Notifier.

func (*Notifier) Alertmanagers

func (n *Notifier) Alertmanagers() []string

Alertmanagers returns a list Alertmanager URLs.

func (*Notifier) ApplyConfig

func (n *Notifier) ApplyConfig(conf *config.Config) error

ApplyConfig updates the status state as the new config requires.

func (*Notifier) Collect

func (n *Notifier) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*Notifier) Describe

func (n *Notifier) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*Notifier) Run

func (n *Notifier) Run()

Run dispatches notifications continuously.

func (*Notifier) Send

func (n *Notifier) Send(alerts ...*model.Alert)

Send queues the given notification requests for processing. Panics if called on a handler that is not running.

func (*Notifier) Stop

func (n *Notifier) Stop()

Stop shuts down the notification handler.

type Options

type Options struct {
	QueueCapacity  int
	ExternalLabels model.LabelSet
	RelabelConfigs []*config.RelabelConfig
}

Options are the configurable parameters of a Handler.