alert

Documentation

Overview

Package alert alert rules and templatize.

Index

• type Alert
  • func (a Alert) CreateSearch(c context.Context) (string, string, interface{}, error)
  • func (a *Alert) Init() error
  • func (a Alert) Run()

Types

type Alert

type Alert struct {
	Name        string            `yaml:"name"`
	Interval    string            `yaml:"interval"`
	SearchIndex string            `yaml:"search_index"`
	SearchType  string            `yaml:"search_type"`
	Search      search.Dict       `yaml:"search"`
	SearchQuery string            `yaml:"search_query"`
	Process     luautil.LuaRunner `yaml:"process"`

	Jobber         *jobber.FullTimeSpec
	SearchIndexTPL *template.Template
	SearchTypeTPL  *template.Template
	SearchTPL      *template.Template
}

Alert encompasses a search query which will be run periodically, the results of which will be checked against a condition. If the condition returns true a set of actions will be performed

func (Alert) CreateSearch

func (a Alert) CreateSearch(c context.Context) (string, string, interface{}, error)

func (*Alert) Init

func (a *Alert) Init() error

Init initializes some internal data inside the Alert, and must be called after the Alert is unmarshaled from yaml (or otherwise created)

func (Alert) Run

func (a Alert) Run()