rules

Documentation

Index

• func CompareGroups(groupOne, groupTwo rulefmt.RuleGroup) error
• func ParseFiles(files []string) (map[string]RuleNamespace, error)
• func ValidateRuleGroup(g rulefmt.RuleGroup) []error
• type RuleNamespace
  • func Parse(content []byte) (*RuleNamespace, []error)
  • func (r RuleNamespace) Validate() []error

Functions

func CompareGroups

func CompareGroups(groupOne, groupTwo rulefmt.RuleGroup) error

CompareGroups differentiates between two rule groups

func ParseFiles

func ParseFiles(files []string) (map[string]RuleNamespace, error)

ParseFiles returns a formatted set of prometheus rule groups

func ValidateRuleGroup

func ValidateRuleGroup(g rulefmt.RuleGroup) []error

ValidateRuleGroup validates a rulegroup

Types

type RuleNamespace

type RuleNamespace struct {
	// Namespace field only exists for setting namespace in namespace body instead of file name
	Namespace string `yaml:"namespace,omitempty"`

	Groups []rulefmt.RuleGroup `yaml:"groups"`
}

RuleNamespace is used to parse a slightly modified prometheus rule file format, if no namespace is set, the default namespace is used. Namespace is functionally the same as a file name.

func Parse

func Parse(content []byte) (*RuleNamespace, []error)

Parse parses and validates a set of rules.

func (RuleNamespace) Validate

func (r RuleNamespace) Validate() []error

Validate each rule in the rule namespace is valid