notifier

Documentation

Index

• type Alert
  • func (a *Alert) Hash() uint64
  • func (a *Alert) Name() string
  • func (a *Alert) Resolved() bool
  • func (a *Alert) ResolvedAt(ts time.Time) bool
  • func (a *Alert) String() string
• type Notifier
  • func New(o *Options, logger log.Logger) *Notifier
  • func (n *Notifier) Alertmanagers() []*url.URL
  • func (n *Notifier) ApplyConfig(conf *config.Config) error
  • func (n *Notifier) Run()
  • func (n *Notifier) Send(alerts ...*Alert)
  • func (n *Notifier) Stop()
• type Options

Types

type Alert

type Alert struct {
	// Label value pairs for purpose of aggregation, matching, and disposition
	// dispatching. This must minimally include an "alertname" label.
	Labels labels.Labels `json:"labels"`

	// Extra key/value information which does not define alert identity.
	Annotations labels.Labels `json:"annotations"`

	// The known time range for this alert. Both ends are optional.
	StartsAt     time.Time `json:"startsAt,omitempty"`
	EndsAt       time.Time `json:"endsAt,omitempty"`
	GeneratorURL string    `json:"generatorURL,omitempty"`
}

Alert is a generic representation of an alert in the Prometheus eco-system.

func (*Alert) Hash

func (a *Alert) Hash() uint64

Hash returns a hash over the alert. It is equivalent to the alert labels hash.

func (*Alert) Name

func (a *Alert) Name() string

Name returns the name of the alert. It is equivalent to the "alertname" label.

func (*Alert) Resolved

func (a *Alert) Resolved() bool

Resolved returns true iff the activity interval ended in the past.

func (*Alert) ResolvedAt

func (a *Alert) ResolvedAt(ts time.Time) bool

ResolvedAt returns true off the activity interval ended before the given timestamp.

func (*Alert) String

func (a *Alert) String() string

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, logger log.Logger) *Notifier

New constructs a new Notifier.

func (*Notifier) Alertmanagers

func (n *Notifier) Alertmanagers() []*url.URL

Alertmanagers returns a slice of 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) Run

func (n *Notifier) Run()

Run dispatches notifications continuously.

func (*Notifier) Send

func (n *Notifier) Send(alerts ...*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
	// Used for sending HTTP requests to the Alertmanager.
	Do func(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)

	Registerer prometheus.Registerer
}

Options are the configurable parameters of a Handler.