alert

Documentation

Overview

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

Index

• type APIVersion
  • func (v *APIVersion) UnmarshalYAML(unmarshal func(interface{}) error) error
• 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 AlertingConfig
  • func LoadAlertingConfig(confYaml []byte) (AlertingConfig, error)
• type Alertmanager
  • func NewAlertmanager(logger log.Logger, dispatcher Dispatcher, timeout time.Duration, ...) *Alertmanager
• type AlertmanagerConfig
  • func BuildAlertmanagerConfig(address string, timeout time.Duration) (AlertmanagerConfig, error)
  • func DefaultAlertmanagerConfig() AlertmanagerConfig
  • func (c *AlertmanagerConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Dispatcher
• 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 []*Alertmanager) *Sender
  • func (s *Sender) Send(ctx context.Context, alerts []*Alert)

Types

type APIVersion

type APIVersion string

APIVersion represents the API version of the Alertmanager endpoint.

const (
	APIv1 APIVersion = "v1"
	APIv2 APIVersion = "v2"
)

func (*APIVersion) UnmarshalYAML

func (v *APIVersion) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

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 AlertingConfig

type AlertingConfig struct {
	Alertmanagers []AlertmanagerConfig `yaml:"alertmanagers"`
}

func LoadAlertingConfig

func LoadAlertingConfig(confYaml []byte) (AlertingConfig, error)

LoadAlertingConfig loads a list of AlertmanagerConfig from YAML data.

type Alertmanager

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

Alertmanager is an HTTP client that can send alerts to a cluster of Alertmanager endpoints.

func NewAlertmanager

func NewAlertmanager(logger log.Logger, dispatcher Dispatcher, timeout time.Duration, version APIVersion) *Alertmanager

NewAlertmanager returns a new Alertmanager client.

type AlertmanagerConfig

type AlertmanagerConfig struct {
	HTTPClientConfig http_util.ClientConfig    `yaml:"http_config"`
	EndpointsConfig  http_util.EndpointsConfig `yaml:",inline"`
	Timeout          model.Duration            `yaml:"timeout"`
	APIVersion       APIVersion                `yaml:"api_version"`
}

AlertmanagerConfig represents a client to a cluster of Alertmanager endpoints.

func BuildAlertmanagerConfig

func BuildAlertmanagerConfig(address string, timeout time.Duration) (AlertmanagerConfig, error)

BuildAlertmanagerConfig initializes and returns an Alertmanager client configuration from a static address.

func DefaultAlertmanagerConfig

func DefaultAlertmanagerConfig() AlertmanagerConfig

func (*AlertmanagerConfig) UnmarshalYAML

func (c *AlertmanagerConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Dispatcher

type Dispatcher interface {
	// Endpoints returns the list of endpoint URLs the dispatcher knows about.
	Endpoints() []*url.URL
	// Do sends an HTTP request and returns a response.
	Do(*http.Request) (*http.Response, error)
}

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, externalLset labels.Labels, excludeLabels []string) *Queue

NewQueue returns a new queue. The given label set is attached to all alerts pushed to the queue. The given exclude label set tells what label names to drop including external labels.

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 []*Alertmanager,
) *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)

Send an alert batch to all given Alertmanager clients. TODO(bwplotka): https://github.com/thanos-io/thanos/issues/660.