alerting

Documentation

Index

• type Alert
• type AlertState
  • func (s AlertState) String() string
• type AlertingRule
  • func (r AlertingRule) State() AlertState
• type AlertingRuleGroup
• type AlertingService
  • func New(cfg *model.Config, alertRuleFiles []model.RuleFile, ...) *AlertingService
  • func (s *AlertingService) DoAlert() error
  • func (s *AlertingService) GetAlertingRuleGroups() []AlertingRuleGroup
  • func (s *AlertingService) GetAlertmanagerDiscovery() promWebAPI.AlertmanagerDiscovery
  • func (s *AlertingService) SendTestAlert() error
• type Fire
• type IAlertingService

Types

type Alert

type Alert struct {
	State       AlertState        `json:"state"`
	CreatedAt   time.Time         `json:"createdAt,omitempty"`
	UpdatedAt   time.Time         `json:"updatedAt,omitempty"`
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`
}

type AlertState

type AlertState int

const (
	StateInactive AlertState = iota
	StatePending
	StateFiring
)

func (AlertState) String

func (s AlertState) String() string

type AlertingRule

type AlertingRule struct {
	Rule   model.Rule        `json:"rule,omitempty"`
	Active map[uint64]*Alert `json:"active,omitempty"`
}

func (AlertingRule) State

func (r AlertingRule) State() AlertState

type AlertingRuleGroup

type AlertingRuleGroup struct {
	DatasourceSelector model.DatasourceSelector `json:"datasourceSelector,omitempty"`
	GroupLabels        map[string]string        `json:"groupLabels,omitempty"`
	AlertingRules      []AlertingRule           `json:"alertingRules,omitempty"`
}

type AlertingService

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

func New

func New(cfg *model.Config, alertRuleFiles []model.RuleFile, datasourceService datasourceservice.IDatasourceService, remoteService *remote.RemoteService) *AlertingService

func (*AlertingService) DoAlert

func (s *AlertingService) DoAlert() error

func (*AlertingService) GetAlertingRuleGroups

func (s *AlertingService) GetAlertingRuleGroups() []AlertingRuleGroup

func (*AlertingService) GetAlertmanagerDiscovery

func (s *AlertingService) GetAlertmanagerDiscovery() promWebAPI.AlertmanagerDiscovery

func (*AlertingService) SendTestAlert

func (s *AlertingService) SendTestAlert() error

type Fire

type Fire struct {
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`
}

type IAlertingService

type IAlertingService interface {
	DoAlert() error
}