config

Documentation

Index

• func HashRule(r Rule) uint64
• func ReadFromFS(paths []string) (map[string][]byte, error)
• type FS
• type Group
  • func Parse(pathPatterns []string, validateTplFn ValidateTplFn, validateExpressions bool) ([]Group, error)
  • func ParseSilent(pathPatterns []string, validateTplFn ValidateTplFn, validateExpressions bool) ([]Group, error)
  • func (g *Group) UnmarshalYAML(unmarshal func(any) error) error
  • func (g *Group) Validate(validateTplFn ValidateTplFn, validateExpressions bool) error
• type Header
  • func (h *Header) UnmarshalYAML(unmarshal func(any) error) error
• type Rule
  • func (r *Rule) Name() string
  • func (r *Rule) String() string
  • func (r *Rule) UnmarshalYAML(unmarshal func(any) error) error
  • func (r *Rule) Validate() error
• type Type
  • func NewGraphiteType() Type
  • func NewPrometheusType() Type
  • func NewRawType(d string) Type
  • func NewVLogsType() Type
  • func (t *Type) Get() string
  • func (t Type) MarshalYAML() (any, error)
  • func (t *Type) Set(d Type)
  • func (t Type) String() string
  • func (t *Type) UnmarshalYAML(unmarshal func(any) error) error
  • func (t *Type) ValidateExpr(expr string) error
• type ValidateTplFn

Functions

func HashRule

func HashRule(r Rule) uint64

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

func ReadFromFS

func ReadFromFS(paths []string) (map[string][]byte, error)

ReadFromFS parses the given path list and inits FS for each item. Once initialed, ReadFromFS will try to read and return files from each FS. ReadFromFS returns an error if at least one FS failed to init. The function can be called multiple times but each unique path will be initialed only once.

It is allowed to mix different FS types in path list.

Types

type FS

type FS interface {
	// Init initializes FS.
	Init() error

	// String must return human-readable representation of FS.
	String() string

	// List returns the list of file names which will be read via Read fn
	List() ([]string, error)

	// Read returns a list of read files in form of a map
	// where key is a file name and value is a content of read file.
	// Read must be called only after the successful Init call.
	Read(files []string) (map[string][]byte, error)
}

FS represent a file system abstract for reading files.

type Group

type Group struct {
	Type       Type `yaml:"type,omitempty"`
	File       string
	Name       string              `yaml:"name"`
	Interval   *promutils.Duration `yaml:"interval,omitempty"`
	EvalOffset *promutils.Duration `yaml:"eval_offset,omitempty"`
	// EvalDelay will adjust the `time` parameter of rule evaluation requests to compensate intentional query delay from datasource.
	// see https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5155
	EvalDelay   *promutils.Duration `yaml:"eval_delay,omitempty"`
	Limit       int                 `yaml:"limit,omitempty"`
	Rules       []Rule              `yaml:"rules"`
	Concurrency int                 `yaml:"concurrency"`
	// Labels is a set of label value pairs, that will be added to every rule.
	// It has priority over the external labels.
	Labels map[string]string `yaml:"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
	// Optional HTTP URL parameters added to each rule request
	Params url.Values `yaml:"params"`
	// Headers contains optional HTTP headers added to each rule request
	Headers []Header `yaml:"headers,omitempty"`
	// NotifierHeaders contains optional HTTP headers sent to notifiers for generated notifications
	NotifierHeaders []Header `yaml:"notifier_headers,omitempty"`
	// EvalAlignment will make the timestamp of group query requests be aligned with interval
	EvalAlignment *bool `yaml:"eval_alignment,omitempty"`
	// Catches all undefined fields and must be empty after parsing.
	XXX map[string]any `yaml:",inline"`
}

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

func Parse

func Parse(pathPatterns []string, validateTplFn ValidateTplFn, validateExpressions bool) ([]Group, error)

Parse parses rule configs from given file patterns

func ParseSilent

func ParseSilent(pathPatterns []string, validateTplFn ValidateTplFn, validateExpressions bool) ([]Group, error)

ParseSilent parses rule configs from given file patterns without emitting logs

func (*Group) UnmarshalYAML

func (g *Group) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Group) Validate

func (g *Group) Validate(validateTplFn ValidateTplFn, validateExpressions bool) error

Validate checks configuration errors for group and internal rules

type Header

type Header struct {
	Key   string
	Value string
}

Header is a Key - Value struct for holding an HTTP header.

func (*Header) UnmarshalYAML

func (h *Header) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type Rule

type Rule struct {
	ID     uint64
	Record string              `yaml:"record,omitempty"`
	Alert  string              `yaml:"alert,omitempty"`
	Expr   string              `yaml:"expr"`
	For    *promutils.Duration `yaml:"for,omitempty"`
	// Alert will continue firing for this long even when the alerting expression no longer has results.
	KeepFiringFor *promutils.Duration `yaml:"keep_firing_for,omitempty"`
	Labels        map[string]string   `yaml:"labels,omitempty"`
	Annotations   map[string]string   `yaml:"annotations,omitempty"`
	Debug         bool                `yaml:"debug,omitempty"`
	// UpdateEntriesLimit defines max number of rule's state updates stored in memory.
	// Overrides `-rule.updateEntriesLimit`.
	UpdateEntriesLimit *int `yaml:"update_entries_limit,omitempty"`

	// Catches all undefined fields and must be empty after parsing.
	XXX map[string]any `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) String

func (r *Rule) String() string

String implements Stringer interface

func (*Rule) UnmarshalYAML

func (r *Rule) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Rule) Validate

func (r *Rule) Validate() error

Validate check for Rule configuration errors

type Type

type Type struct {
	Name string
}

Type represents data source type

func NewGraphiteType

func NewGraphiteType() Type

NewGraphiteType returns graphite datasource type

func NewPrometheusType

func NewPrometheusType() Type

NewPrometheusType returns prometheus datasource type

func NewRawType

func NewRawType(d string) Type

NewRawType returns datasource type from raw string without validation.

func NewVLogsType

func NewVLogsType() Type

NewVLogsType returns victorialogs datasource type

func (*Type) Get

func (t *Type) Get() string

Get returns datasource type

func (Type) MarshalYAML

func (t Type) MarshalYAML() (any, error)

MarshalYAML implements the yaml.Unmarshaler interface.

func (*Type) Set

func (t *Type) Set(d Type)

Set changes datasource type

func (Type) String

func (t Type) String() string

String implements String interface with default value.

func (*Type) UnmarshalYAML

func (t *Type) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Type) ValidateExpr

func (t *Type) ValidateExpr(expr string) error

ValidateExpr validates query expression with datasource ql.

type ValidateTplFn

type ValidateTplFn func(annotations map[string]string) error

ValidateTplFn must validate the given annotations