model

Documentation

Index

• type Alert
• type AlertMessage
• type Alerts
  • func (as Alerts) Firing() []Alert
  • func (as Alerts) ForwardNotify() string
  • func (as Alerts) GetInstance() string
  • func (as Alerts) Panel() GrafanaPanel
  • func (as Alerts) Resolved() []Alert
  • func (as Alerts) SendNotify() string
  • func (as Alerts) Severity() string
• type GrafanaPanel
• type KV
  • func (kv KV) Names() []string
  • func (kv KV) Remove(keys []string) KV
  • func (kv KV) SortedPairs() Pairs
  • func (kv KV) Values() []string
• type Pair
• type Pairs
  • func (ps Pairs) Names() []string
  • func (ps Pairs) Values() []string
• type WebhookMessage

Types

type Alert

type Alert struct {
	Status       string    `json:"status"`
	Labels       KV        `json:"labels"`
	Annotations  KV        `json:"annotations"`
	StartsAt     time.Time `json:"startsAt"`
	EndsAt       time.Time `json:"endsAt"`
	GeneratorURL string    `json:"generatorURL"`
	Fingerprint  string    `json:"fingerprint"`
}

Alert holds one alert for notification templates.

type AlertMessage

type AlertMessage struct {
	Receiver string `json:"receiver"`
	Status   string `json:"status"`
	Alerts   Alerts `json:"alerts"`

	GroupLabels       KV `json:"groupLabels"`
	CommonLabels      KV `json:"commonLabels"`
	CommonAnnotations KV `json:"commonAnnotations"`

	ExternalURL string `json:"externalURL"`
}

Data is the data passed to notification templates and webhook pushes.

End-users should not be exposed to Go's type system, as this will confuse them and prevent simple things like simple equality checks to fail. Map everything to float64/string.

type Alerts

type Alerts []Alert

Alerts is a list of Alert objects.

func (Alerts) Firing

func (as Alerts) Firing() []Alert

Firing returns the subset of alerts that are firing.

func (Alerts) ForwardNotify

func (as Alerts) ForwardNotify() string

func (Alerts) GetInstance

func (as Alerts) GetInstance() string

func (Alerts) Panel

func (as Alerts) Panel() GrafanaPanel

func (Alerts) Resolved

func (as Alerts) Resolved() []Alert

Resolved returns the subset of alerts that are resolved.

func (Alerts) SendNotify

func (as Alerts) SendNotify() string

func (Alerts) Severity

func (as Alerts) Severity() string

Resolved returns the subset of alerts that are resolved.

type GrafanaPanel

type GrafanaPanel struct {
	Dashboard     string `json:"dashboard"`
	PanelID       string `json:"panel_id"`
	TimeRange     string `json:"time_range"`
	SpecialParams string `json:"special_params"`
}

type KV

type KV map[string]string

KV is a set of key/value string pairs.

func (KV) Names

func (kv KV) Names() []string

Names returns the names of the label names in the LabelSet.

func (KV) Remove

func (kv KV) Remove(keys []string) KV

Remove returns a copy of the key/value set without the given keys.

func (KV) SortedPairs

func (kv KV) SortedPairs() Pairs

SortedPairs returns a sorted list of key/value pairs.

func (KV) Values

func (kv KV) Values() []string

Values returns a list of the values in the LabelSet.

type Pair

type Pair struct {
	Name, Value string
}

Pair is a key/value string pair.

type Pairs

type Pairs []Pair

Pairs is a list of key/value string pairs.

func (Pairs) Names

func (ps Pairs) Names() []string

Names returns a list of names of the pairs.

func (Pairs) Values

func (ps Pairs) Values() []string

Values returns a list of values of the pairs.

type WebhookMessage

type WebhookMessage struct {
	// reference: https://prometheus.io/docs/alerting/latest/notifications/
	AlertMessage
	OpenIDs        []string
	Meta           KV
	FiringAlerts   Alerts
	ResolvedAlerts Alerts
	TitlePrefix    string
	FiringNum      int
	Severity       string
	SendNotify     string
	PanelURL       string
	AlertHosts     map[string]string
}