types

Documentation

Index

• func Alerts(alerts ...*Alert) model.Alerts
• type Alert
  • func (a *Alert) Merge(o *Alert) *Alert
• type AlertSlice
  • func (as AlertSlice) Len() int
  • func (as AlertSlice) Less(i, j int) bool
  • func (as AlertSlice) Swap(i, j int)
• type AlertState
• type AlertStatus
• type Marker
  • func NewMarker(r prometheus.Registerer) Marker
• type Matcher
  • func NewMatcher(name model.LabelName, value string) *Matcher
  • func NewRegexMatcher(name model.LabelName, re *regexp.Regexp) *Matcher
  • func (m *Matcher) Init() error
  • func (m *Matcher) Match(lset model.LabelSet) bool
  • func (m *Matcher) String() string
  • func (m *Matcher) Validate() error
• type Matchers
  • func NewMatchers(ms ...*Matcher) Matchers
  • func (ms Matchers) Equal(o Matchers) bool
  • func (ms Matchers) Len() int
  • func (ms Matchers) Less(i, j int) bool
  • func (ms Matchers) Match(lset model.LabelSet) bool
  • func (ms Matchers) String() string
  • func (ms Matchers) Swap(i, j int)
• type MultiError
  • func (e *MultiError) Add(err error)
  • func (e *MultiError) Error() string
  • func (e *MultiError) Errors() []error
  • func (e *MultiError) Len() int
• type MuteFunc
  • func (f MuteFunc) Mutes(lset model.LabelSet) bool
• type Muter
• type Silence
  • func (s *Silence) Expired() bool
• type SilenceState
  • func CalcSilenceState(start, end time.Time) SilenceState
• type SilenceStatus

Functions

func Alerts

func Alerts(alerts ...*Alert) model.Alerts

Alerts turns a sequence of internal alerts into a list of exposable model.Alert structures.

Types

type Alert

type Alert struct {
	model.Alert

	// The authoritative timestamp.
	UpdatedAt time.Time
	Timeout   bool
}

Alert wraps a model.Alert with additional information relevant to internal of the Alertmanager. The type is never exposed to external communication and the embedded alert has to be sanitized beforehand.

func (*Alert) Merge

func (a *Alert) Merge(o *Alert) *Alert

Merge merges the timespan of two alerts based and overwrites annotations based on the authoritative timestamp. A new alert is returned, the labels are assumed to be equal.

type AlertSlice

type AlertSlice []*Alert

AlertSlice is a sortable slice of Alerts.

func (AlertSlice) Len

func (as AlertSlice) Len() int

func (AlertSlice) Less

func (as AlertSlice) Less(i, j int) bool

func (AlertSlice) Swap

func (as AlertSlice) Swap(i, j int)

type AlertState

type AlertState string

AlertState is used as part of AlertStatus.

const (
	AlertStateUnprocessed AlertState = "unprocessed"
	AlertStateActive      AlertState = "active"
	AlertStateSuppressed  AlertState = "suppressed"
)

Possible values for AlertState.

type AlertStatus

type AlertStatus struct {
	State       AlertState `json:"state"`
	SilencedBy  []string   `json:"silencedBy"`
	InhibitedBy []string   `json:"inhibitedBy"`
	// contains filtered or unexported fields
}

AlertStatus stores the state of an alert and, as applicable, the IDs of silences silencing the alert and of other alerts inhibiting the alert. Note that currently, SilencedBy is supposed to be the complete set of the relevant silences while InhibitedBy may contain only a subset of the inhibiting alerts – in practice exactly one ID. (This somewhat confusing semantics might change in the future.)

type Marker

type Marker interface {
	// SetActive sets the provided alert to AlertStateActive and deletes all
	// SilencedBy and InhibitedBy entries.
	SetActive(alert model.Fingerprint)
	// SetSilenced replaces the previous SilencedBy by the provided IDs of
	// silences, including the version number of the silences state. The set
	// of provided IDs is supposed to represent the complete set of relevant
	// silences. If no ID is provided and InhibitedBy is already empty, this
	// call is equivalent to SetActive. Otherwise, it sets
	// AlertStateSuppressed.
	SetSilenced(alert model.Fingerprint, version int, silenceIDs ...string)
	// SetInhibited replaces the previous InhibitedBy by the provided IDs of
	// alerts. In contrast to SetSilenced, the set of provided IDs is not
	// expected to represent the complete set of inhibiting alerts. (In
	// practice, this method is only called with one or zero IDs. However,
	// this expectation might change in the future.) If no ID is provided and
	// SilencedBy is already empty, this call is equivalent to
	// SetActive. Otherwise, it sets AlertStateSuppressed.
	SetInhibited(alert model.Fingerprint, alertIDs ...string)

	// Count alerts of the given state(s). With no state provided, count all
	// alerts.
	Count(...AlertState) int

	// Status of the given alert.
	Status(model.Fingerprint) AlertStatus
	// Delete the given alert.
	Delete(model.Fingerprint)

	// Various methods to inquire if the given alert is in a certain
	// AlertState. Silenced also returns all the silencing silences, while
	// Inhibited may return only a subset of inhibiting alerts. Silenced
	// also returns the version of the silences state the result is based
	// on.
	Unprocessed(model.Fingerprint) bool
	Active(model.Fingerprint) bool
	Silenced(model.Fingerprint) ([]string, int, bool)
	Inhibited(model.Fingerprint) ([]string, bool)
}

Marker helps to mark alerts as silenced and/or inhibited. All methods are goroutine-safe.

func NewMarker

func NewMarker(r prometheus.Registerer) Marker

NewMarker returns an instance of a Marker implementation.

type Matcher

type Matcher struct {
	Name    string `json:"name"`
	Value   string `json:"value"`
	IsRegex bool   `json:"isRegex"`
	// contains filtered or unexported fields
}

Matcher defines a matching rule for the value of a given label.

func NewMatcher

func NewMatcher(name model.LabelName, value string) *Matcher

NewMatcher returns a new matcher that compares against equality of the given value.

func NewRegexMatcher

func NewRegexMatcher(name model.LabelName, re *regexp.Regexp) *Matcher

NewRegexMatcher returns a new matcher that compares values against a regular expression. The matcher is already initialized.

TODO(fabxc): refactor usage.

func (*Matcher) Init

func (m *Matcher) Init() error

Init internals of the Matcher. Must be called before using Match.

func (*Matcher) Match

func (m *Matcher) Match(lset model.LabelSet) bool

Match checks whether the label of the matcher has the specified matching value.

func (*Matcher) String

func (m *Matcher) String() string

func (*Matcher) Validate

func (m *Matcher) Validate() error

Validate returns true iff all fields of the matcher have valid values.

type Matchers

type Matchers []*Matcher

Matchers provides the Match and Fingerprint methods for a slice of Matchers. Matchers must always be sorted.

func NewMatchers

func NewMatchers(ms ...*Matcher) Matchers

NewMatchers returns the given Matchers sorted.

func (Matchers) Equal

func (ms Matchers) Equal(o Matchers) bool

Equal returns whether both Matchers are equal.

func (Matchers) Len

func (ms Matchers) Len() int

func (Matchers) Less

func (ms Matchers) Less(i, j int) bool

func (Matchers) Match

func (ms Matchers) Match(lset model.LabelSet) bool

Match checks whether all matchers are fulfilled against the given label set.

func (Matchers) String

func (ms Matchers) String() string

func (Matchers) Swap

func (ms Matchers) Swap(i, j int)

type MultiError

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

MultiError contains multiple errors and implements the error interface. Its zero value is ready to use. All its methods are goroutine safe.

func (*MultiError) Add

func (e *MultiError) Add(err error)

Add adds an error to the MultiError.

func (*MultiError) Error

func (e *MultiError) Error() string

func (*MultiError) Errors

func (e *MultiError) Errors() []error

Errors returns the errors added to the MuliError. The returned slice is a copy of the internal slice of errors.

func (*MultiError) Len

func (e *MultiError) Len() int

Len returns the number of errors added to the MultiError.

type MuteFunc

type MuteFunc func(model.LabelSet) bool

A MuteFunc is a function that implements the Muter interface.

func (MuteFunc) Mutes

func (f MuteFunc) Mutes(lset model.LabelSet) bool

Mutes implements the Muter interface.

type Muter

type Muter interface {
	Mutes(model.LabelSet) bool
}

A Muter determines whether a given label set is muted. Implementers that maintain an underlying Marker are expected to update it during a call of Mutes.

type Silence

type Silence struct {
	// A unique identifier across all connected instances.
	ID string `json:"id"`
	// A set of matchers determining if a label set is affect
	// by the silence.
	Matchers Matchers `json:"matchers"`

	// Time range of the silence.
	//
	// * StartsAt must not be before creation time
	// * EndsAt must be after StartsAt
	// * Deleting a silence means to set EndsAt to now
	// * Time range must not be modified in different ways
	//
	// TODO(fabxc): this may potentially be extended by
	// creation and update timestamps.
	StartsAt time.Time `json:"startsAt"`
	EndsAt   time.Time `json:"endsAt"`

	// The last time the silence was updated.
	UpdatedAt time.Time `json:"updatedAt"`

	// Information about who created the silence for which reason.
	CreatedBy string `json:"createdBy"`
	Comment   string `json:"comment,omitempty"`

	Status SilenceStatus `json:"status"`
}

A Silence determines whether a given label set is muted.

func (*Silence) Expired

func (s *Silence) Expired() bool

Expired return if the silence is expired meaning that both StartsAt and EndsAt are equal

type SilenceState

type SilenceState string

SilenceState is used as part of SilenceStatus.

const (
	SilenceStateExpired SilenceState = "expired"
	SilenceStateActive  SilenceState = "active"
	SilenceStatePending SilenceState = "pending"
)

Possible values for SilenceState.

func CalcSilenceState

func CalcSilenceState(start, end time.Time) SilenceState

CalcSilenceState returns the SilenceState that a silence with the given start and end time would have right now.

type SilenceStatus

type SilenceStatus struct {
	State SilenceState `json:"state"`
}

SilenceStatus stores the state of a silence.