Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Rule ¶
type Rule struct {
Record string `yaml:"record,omitempty"`
Alert string `yaml:"alert,omitempty"`
Expr string `yaml:"expr"`
For model.Duration `yaml:"for,omitempty"`
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 an alerting or recording rule.
type RuleGroup ¶
type RuleGroup struct {
Name string `yaml:"name"`
Interval model.Duration `yaml:"interval,omitempty"`
Rules []Rule `yaml:"rules"`
// Catches all undefined fields and must be empty after parsing.
XXX map[string]interface{} `yaml:",inline"`
}
RuleGroup is a list of sequentially evaluated recording and alerting rules.
type RuleGroups ¶
type RuleGroups struct {
Groups []RuleGroup `yaml:"groups"`
// Catches all undefined fields and must be empty after parsing.
XXX map[string]interface{} `yaml:",inline"`
}
RuleGroups is a set of rule groups that are typically exposed in a file.
func Parse ¶
func Parse(content []byte) (*RuleGroups, []error)
Parse parses and validates a set of rules.
func ParseFile ¶
func ParseFile(file string) (*RuleGroups, []error)
ParseFile reads and parses rules from a file.
func (*RuleGroups) Validate ¶
func (g *RuleGroups) Validate() (errs []error)
Validate validates all rules in the rule groups.
Click to show internal directories.
Click to hide internal directories.