alert

Documentation

Overview

Package alert contains logic to send alert notifications to Alertmanager clusters.

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 Queue
  • func NewQueue(logger log.Logger, reg prometheus.Registerer, capacity, maxBatchSize int, ...) *Queue
  • func (q *Queue) Cap() int
  • func (q *Queue) Len() int
  • func (q *Queue) Pop(termc <-chan struct{}) []*Alert
  • func (q *Queue) Push(alerts []*Alert)
• type Sender
  • func NewSender(logger log.Logger, reg prometheus.Registerer, alertmanagers func() []*url.URL, ...) *Sender
  • func (s *Sender) Send(ctx context.Context, alerts []*Alert) error

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. Start and end time are both 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 Queue

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

Queue is a queue of alert notifications waiting to be sent. The queue is consumed in batches and entries are dropped at the front if it runs full.

func NewQueue

func NewQueue(logger log.Logger, reg prometheus.Registerer, capacity, maxBatchSize int, lset labels.Labels) *Queue

NewQueue returns a new queue. The given label set is attached to all alerts pushed to the queue.

func (*Queue) Cap

func (q *Queue) Cap() int

Cap returns the fixed capacity of the queue.

func (*Queue) Len

func (q *Queue) Len() int

Len returns the current length of the queue.

func (*Queue) Pop

func (q *Queue) Pop(termc <-chan struct{}) []*Alert

Pop takes a batch of alerts from the front of the queue. The batch size is limited according to the queues maxBatchSize limit. It blocks until elements are available or a termination signal is send on termc.

func (*Queue) Push

func (q *Queue) Push(alerts []*Alert)

Push adds a list of alerts to the queue.

type Sender

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

Sender sends notifications to a dynamic set of alertmanagers.

func NewSender

func NewSender(
	logger log.Logger,
	reg prometheus.Registerer,
	alertmanagers func() []*url.URL,
	doReq func(req *http.Request) (*http.Response, error),
) *Sender

NewSender returns a new sender. On each call to Send the entire alert batch is sent to each Alertmanager returned by the getter function.

func (*Sender) Send

func (s *Sender) Send(ctx context.Context, alerts []*Alert) error

Send an alert batch to all given Alertmanager URLs.