types

Documentation

Index

• Variables
• func Alerts(alerts ...*Alert) model.Alerts
• func ByCreatedAt(i, j *Silence) bool
• func ByEndsAt(i, j *Silence) bool
• func ByStartsAt(i, j *Silence) bool
• 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 Marker
  • func NewMarker() Marker
• type Matcher
  • func NewMatcher(name model.LabelName, value string) *Matcher
  • func NewRegexMatcher(name model.LabelName, re *regexp.Regexp) *Matcher
  • func (m *Matcher) IsRegex() bool
  • func (m *Matcher) MarshalJSON() ([]byte, error)
  • func (m *Matcher) Match(lset model.LabelSet) bool
  • func (m *Matcher) String() string
• type Matchers
  • func (ms Matchers) Fingerprint() model.Fingerprint
  • func (ms Matchers) Match(lset model.LabelSet) bool
• 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 NotifyInfo
  • func (n *NotifyInfo) Fingerprint() model.Fingerprint
  • func (n *NotifyInfo) String() string
• type Silence
  • func NewSilence(s *model.Silence) *Silence
  • func (sil *Silence) Mutes(lset model.LabelSet) bool
• type SilencesLessFunc
• type SilencesQueryResponse
• type SilencesSorter
  • func NewSilencesSorter(s []*Silence, fn SilencesLessFunc) *SilencesSorter
  • func (ss SilencesSorter) Len() int
  • func (ss SilencesSorter) Less(i, j int) bool
  • func (ss SilencesSorter) Swap(i, j int)
• type SortKey

Variables

var (
	ErrRequestExceedsAvailable = errors.New("requested offset surpasses total number of resource")
)

var SilenceLessFuncs = map[SortKey]SilencesLessFunc{
	// contains filtered or unexported fields
}

SilenceLessFuncs provides a typesafe way to take user input and select a SilencesLessFunc.

Functions

func Alerts

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

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

func ByCreatedAt

func ByCreatedAt(i, j *Silence) bool

ByCreatedAt sorts compares CreatedAt times for silences.

func ByEndsAt

func ByEndsAt(i, j *Silence) bool

ByEndsAt sorts compares EndsAt times for silences.

func ByStartsAt

func ByStartsAt(i, j *Silence) bool

ByStartsAt sorts compares StartsAt times for silences.

Types

type Alert

type Alert struct {
	model.Alert

	// The authoritative timestamp.
	UpdatedAt    time.Time
	Timeout      bool
	WasSilenced  bool `json:"-"`
	WasInhibited bool `json:"-"`
}

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 Marker

type Marker interface {
	SetInhibited(alert model.Fingerprint, b bool)
	SetSilenced(alert model.Fingerprint, sil ...uint64)

	Silenced(alert model.Fingerprint) (uint64, bool)
	Inhibited(alert model.Fingerprint) bool
}

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

func NewMarker

func NewMarker() Marker

NewMarker returns an instance of a Marker implementation.

type Matcher

type Matcher struct {
	Name  model.LabelName
	Value string
	// 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 treats value as a regular expression which is used for matching.

func (*Matcher) IsRegex

func (m *Matcher) IsRegex() bool

IsRegex returns true of the matcher compares against a regular expression.

func (*Matcher) MarshalJSON

func (m *Matcher) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

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

type Matchers

type Matchers []*Matcher

Matchers provides the Match and Fingerprint methods for a slice of Matchers.

func (Matchers) Fingerprint

func (ms Matchers) Fingerprint() model.Fingerprint

Fingerprint returns a quasi-unique fingerprint for the matchers.

func (Matchers) Match

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

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

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.

type NotifyInfo

type NotifyInfo struct {
	Alert     model.Fingerprint
	Receiver  string
	Resolved  bool
	Timestamp time.Time
}

NotifyInfo holds information about the last successful notification of an alert to a receiver.

func (*NotifyInfo) Fingerprint

func (n *NotifyInfo) Fingerprint() model.Fingerprint

Fingerprint returns a quasi-unique fingerprint for the NotifyInfo.

func (*NotifyInfo) String

func (n *NotifyInfo) String() string

type Silence

type Silence struct {
	model.Silence

	// A set of matchers determining if an alert is affected
	// by the silence.
	Matchers Matchers `json:"-"`
	// contains filtered or unexported fields
}

A Silence determines whether a given label set is muted at the current time.

func NewSilence

func NewSilence(s *model.Silence) *Silence

NewSilence creates a new internal Silence from a public silence object.

func (*Silence) Mutes

func (sil *Silence) Mutes(lset model.LabelSet) bool

Mutes implements the Muter interface.

type SilencesLessFunc

type SilencesLessFunc func(i, j *Silence) bool

type SilencesQueryResponse

type SilencesQueryResponse struct {
	// Silences returned by query.
	Silences []*Silence `json:"silences"`
	// Total silences.
	TotalSilences int `json:"totalSilences"`
}

SilencesQueryResponse is the data structure returned from the Query method.

type SilencesSorter

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

SilencesSorter implements the sort interface to sort a slice of silences according to less.

func NewSilencesSorter

func NewSilencesSorter(s []*Silence, fn SilencesLessFunc) *SilencesSorter

NewSilencesSorter returns a new SilencesSorter.

func (SilencesSorter) Len

func (ss SilencesSorter) Len() int

func (SilencesSorter) Less

func (ss SilencesSorter) Less(i, j int) bool

func (SilencesSorter) Swap

func (ss SilencesSorter) Swap(i, j int)

type SortKey

type SortKey string