config

Documentation

Index

• func HashRule(r Rule) uint64
• type Group
  • func Parse(pathPatterns []string, validateAnnotations, validateExpressions bool) ([]Group, error)
  • func (g *Group) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (g *Group) Validate(validateAnnotations, validateExpressions bool) error
• type Rule
  • func (r *Rule) Name() string
  • func (r *Rule) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (r *Rule) Validate() error

Functions

func HashRule

func HashRule(r Rule) uint64

HashRule hashes significant Rule fields into unique hash that supposed to define Rule uniqueness

Types

type Group

type Group struct {
	Type        datasource.Type `yaml:"type,omitempty"`
	File        string
	Name        string             `yaml:"name"`
	Interval    utils.PromDuration `yaml:"interval,omitempty"`
	Rules       []Rule             `yaml:"rules"`
	Concurrency int                `yaml:"concurrency"`
	// ExtraFilterLabels is a list label filters applied to every rule
	// request withing a group. Is compatible only with VM datasources.
	// See https://docs.victoriametrics.com#prometheus-querying-api-enhancements
	ExtraFilterLabels map[string]string `yaml:"extra_filter_labels"`
	// Checksum stores the hash of yaml definition for this group.
	// May be used to detect any changes like rules re-ordering etc.
	Checksum string

	// 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, validateExpressions bool) ([]Group, error)

Parse parses rule configs from given file patterns

func (*Group) UnmarshalYAML

func (g *Group) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Group) Validate

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

Validate check for internal Group or Rule configuration errors

type Rule

type Rule struct {
	ID          uint64
	Type        datasource.Type    `yaml:"type,omitempty"`
	Record      string             `yaml:"record,omitempty"`
	Alert       string             `yaml:"alert,omitempty"`
	Expr        string             `yaml:"expr"`
	For         utils.PromDuration `yaml:"for"`
	Labels      map[string]string  `yaml:"labels,omitempty"`
	Annotations map[string]string  `yaml:"annotations,omitempty"`

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

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

func (*Rule) Name

func (r *Rule) Name() string

Name returns Rule name according to its type

func (*Rule) UnmarshalYAML

func (r *Rule) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Rule) Validate

func (r *Rule) Validate() error

Validate check for Rule configuration errors