rule

Documentation

Index

• Constants
• Variables
• func MergeConfig(rule config.RuleConfig) config.RuleConfig
• func NeedAlert(res map[string]interface{}, script string) (alert bool, err error)
• func Run(con config.Config) error
• type Rule
  • func CreateRule(con config.RuleConfig) Rule
  • func GetRule(ruleConfig config.RuleConfig) (rule Rule, err error)
• type RuleContext
  • func RunRule(ruleConfig config.RuleConfig) (rc *RuleContext, err error)
  • func (rc *RuleContext) Restart() error
  • func (rc *RuleContext) Start() error
  • func (rc *RuleContext) Stop() error
• type RuleError
  • func (ruleError RuleError) Error() string
• type SampleRule
  • func (rule SampleRule) GetName() string
  • func (rule SampleRule) Run(ctx context.Context)

Constants

const (
	STOP = iota
	START
)

Variables

var RuleContextMap = map[string]*RuleContext{}

RuleContextMap 保存各个rule允许的状态

Functions

func MergeConfig

func MergeConfig(rule config.RuleConfig) config.RuleConfig

MergeConfig 合并原始信息

func NeedAlert

func NeedAlert(res map[string]interface{}, script string) (alert bool, err error)

NeedAlert 根据结果判断是否需要发送报警信息

func Run

func Run(con config.Config) error

Run 启动配置参数

Types

type Rule

type Rule interface {
	GetName() string
	Run(ctx context.Context)
}

func CreateRule

func CreateRule(con config.RuleConfig) Rule

func GetRule

func GetRule(ruleConfig config.RuleConfig) (rule Rule, err error)

GetRule 根据配置获取rule运行时

type RuleContext

type RuleContext struct {
	Status int

	RuleConfig config.RuleConfig
	// contains filtered or unexported fields
}

RuleContext rule运行的上下文

func RunRule

func RunRule(ruleConfig config.RuleConfig) (rc *RuleContext, err error)

RunRule 根据rule配置运行rule并保存在context中，会自动合并总配置文件的配置

func (*RuleContext) Restart

func (rc *RuleContext) Restart() error

Restart 如果已经启动，重新启动；如果没有启动，启动该rule

func (*RuleContext) Start

func (rc *RuleContext) Start() error

Start 启动某个rule

func (*RuleContext) Stop

func (rc *RuleContext) Stop() error

Stop 停止某个rule

type RuleError

type RuleError struct {
	Message string
}

func (RuleError) Error

func (ruleError RuleError) Error() string

type SampleRule

type SampleRule struct {
	Name    string
	Storage storage.Storage
	Tick    *time.Ticker
	Time    int32
	Script  string
	Alerter []alert.Alerter
}

func (SampleRule) GetName

func (rule SampleRule) GetName() string

func (SampleRule) Run

func (rule SampleRule) Run(ctx context.Context)