config

Documentation

Index

• type Group
  • func Parse(pathPatterns []string, validateAnnotations bool) ([]Group, error)
  • func (g *Group) Validate(validateAnnotations bool) error
• type Rule
  • func (r *Rule) Validate() error

Types

type Group

type Group struct {
	File     string
	Name     string        `yaml:"name"`
	Interval time.Duration `yaml:"interval,omitempty"`
	Rules    []Rule        `yaml:"rules"`

	// Catches all undefined fields and must be empty after parsing.
	XXX map[string]interface{} `yaml:",inline"`
}

Group contains list of Rules grouped into entity with one name and evaluation interval

func Parse

func Parse(pathPatterns []string, validateAnnotations bool) ([]Group, error)

Parse parses rule configs from given file patterns

func (*Group) Validate

func (g *Group) Validate(validateAnnotations bool) error

Validate check for internal Group or Rule configuration errors

type Rule

type Rule struct {
	Record      string            `yaml:"record,omitempty"`
	Alert       string            `yaml:"alert,omitempty"`
	Expr        string            `yaml:"expr"`
	For         time.Duration     `yaml:"for,omitempty"`
	Labels      map[string]string `yaml:"labels,omitempty"`
	Annotations map[string]string `yaml:"annotations,omitempty"`
}

Rule describes entity that represent either recording rule or alerting rule.

func (*Rule) Validate

func (r *Rule) Validate() error

Validate check for Rule configuration errors