alerting

Documentation

Index

• type Alert
• type AlertEvent
• type AlertType
• type Alerting
  • func NewAlertingSystem(j journal.Journal) *Alerting
  • func (a *Alerting) AddAlertType(system, subsystem string) AlertType
  • func (a *Alerting) GetAlerts() []Alert
  • func (a *Alerting) IsRaised(at AlertType) bool
  • func (a *Alerting) Raise(at AlertType, message interface{})
  • func (a *Alerting) Resolve(at AlertType, message interface{})

Types

type Alert

type Alert struct {
	Type   AlertType
	Active bool

	LastActive   *AlertEvent // NOTE: pointer for nullability, don't mutate the referenced object!
	LastResolved *AlertEvent
	// contains filtered or unexported fields
}

type AlertEvent

type AlertEvent struct {
	Type    string // either 'raised' or 'resolved'
	Message json.RawMessage
	Time    time.Time
}

AlertEvent contains information about alert state transition

type AlertType

type AlertType struct {
	System, Subsystem string
}

AlertType is a unique alert identifier

type Alerting

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

Alerting provides simple stateful alert system. Consumers can register alerts, which can be raised and resolved.

When an alert is raised or resolved, a related journal entry is recorded.

func NewAlertingSystem

func NewAlertingSystem(j journal.Journal) *Alerting

func (*Alerting) AddAlertType

func (a *Alerting) AddAlertType(system, subsystem string) AlertType

func (*Alerting) GetAlerts

func (a *Alerting) GetAlerts() []Alert

GetAlerts returns all registered (active and inactive) alerts

func (*Alerting) IsRaised

func (a *Alerting) IsRaised(at AlertType) bool

func (*Alerting) Raise

func (a *Alerting) Raise(at AlertType, message interface{})

Raise marks the alert condition as active and records related event in the journal

func (*Alerting) Resolve

func (a *Alerting) Resolve(at AlertType, message interface{})

Resolve marks the alert condition as resolved and records related event in the journal