parser

package
v0.73.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrRuleCommentOnFile = errors.New("this comment is only valid when attached to a rule")

Functions

This section is empty.

Types

type AlertingRule

type AlertingRule struct {
	Expr          PromQLExpr
	For           *YamlNode
	KeepFiringFor *YamlNode
	Labels        *YamlMap
	Annotations   *YamlMap
	Alert         YamlNode
}

func (*AlertingRule) IsIdentical added in v0.50.0

func (ar *AlertingRule) IsIdentical(b *AlertingRule) bool

type ContentReader added in v0.72.0

type ContentReader struct {
	// contains filtered or unexported fields
}

func (*ContentReader) Read added in v0.72.0

func (r *ContentReader) Read(b []byte) (got int, err error)

type File added in v0.72.0

type File struct {
	Diagnostics []diags.Diagnostic
	Comments    []comments.Comment
	Groups      []Group
	Error       ParseError
	TotalLines  int
	IsRelaxed   bool
	IsIgnored   bool
}

type Group added in v0.72.0

type Group struct {
	Labels      *YamlMap
	Name        string
	Error       ParseError
	Rules       []Rule
	Interval    time.Duration
	QueryOffset time.Duration
	Limit       int
}

type ParseError

type ParseError struct {
	Err     error
	Details string
	Line    int
}

Use insread of StrictError.

func (ParseError) Error added in v0.61.0

func (pe ParseError) Error() string

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func NewParser

func NewParser(isStrict bool, schema Schema, names model.ValidationScheme) Parser

func (Parser) Parse

func (p Parser) Parse(src io.Reader) (f File)

type PromQLExpr

type PromQLExpr struct {
	Value       *YamlNode
	SyntaxError error
	Query       *PromQLNode
}

func (PromQLExpr) IsIdentical added in v0.50.0

func (pqle PromQLExpr) IsIdentical(b PromQLExpr) bool

type PromQLNode

type PromQLNode struct {
	Parent   *PromQLNode
	Expr     promParser.Node
	Children []*PromQLNode
}

PromQLNode is used to turn the parsed PromQL query expression into a tree. This allows us to walk the tree up & down and look for either parents or children of specific type. Which is useful if you, for example, want to check if all vector selectors are wrapped inside function calls etc.

func DecodeExpr added in v0.2.0

func DecodeExpr(expr string) (*PromQLNode, error)

func WalkDownExpr added in v0.56.0

func WalkDownExpr[T promParser.Node](node *PromQLNode) (nodes []*PromQLNode)

WalkDownExpr works just like WalkUpExpr but it walks the tree down, visiting all children. It also starts by checking the node passed to it before walking down the tree.

func WalkUpExpr added in v0.56.0

func WalkUpExpr[T promParser.Node](node *PromQLNode) (nodes []*PromQLNode)

WalkUpExpr allows to iterate a promQLNode node looking for parents of specific type. Prometheus parser returns interfaces which makes it more difficult to figure out what kind of node we're dealing with, hence this helper takes a type parameter it tries to cast. It starts by checking the node passed to it and then walks up by visiting all parent nodes.

func WalkUpParent added in v0.56.0

func WalkUpParent[T promParser.Node](node *PromQLNode) (nodes []*PromQLNode)

WalkUpParent works like WalkUpExpr but checks the parent (if present) instead of the node itself. It returns the nodes where the parent is of given type.

func (PromQLNode) MarshalJSON added in v0.56.0

func (pn PromQLNode) MarshalJSON() ([]byte, error)

type RecordingRule

type RecordingRule struct {
	Expr   PromQLExpr
	Labels *YamlMap
	Record YamlNode
}

func (*RecordingRule) IsIdentical added in v0.50.0

func (rr *RecordingRule) IsIdentical(b *RecordingRule) bool

type Rule

type Rule struct {
	AlertingRule  *AlertingRule
	RecordingRule *RecordingRule
	Comments      []comments.Comment
	Error         ParseError
	Lines         diags.LineRange
}

func (Rule) Expr

func (r Rule) Expr() PromQLExpr

func (Rule) IsIdentical added in v0.50.0

func (r Rule) IsIdentical(b Rule) bool

func (Rule) IsSame added in v0.27.0

func (r Rule) IsSame(nr Rule) bool

func (Rule) LastKey added in v0.71.0

func (r Rule) LastKey() (node *YamlNode)

func (Rule) Name added in v0.40.1

func (r Rule) Name() string

func (Rule) NameNode added in v0.71.1

func (r Rule) NameNode() YamlNode

func (Rule) Type added in v0.40.1

func (r Rule) Type() RuleType

type RuleType added in v0.40.1

type RuleType string
const (
	AlertingRuleType  RuleType = "alerting"
	RecordingRuleType RuleType = "recording"
	InvalidRuleType   RuleType = "invalid"
)

type Schema added in v0.69.0

type Schema int
const (
	PrometheusSchema Schema = iota
	ThanosSchema
)

type YamlKeyValue

type YamlKeyValue struct {
	Key   *YamlNode
	Value *YamlNode
}

type YamlMap

type YamlMap struct {
	Key   *YamlNode
	Items []*YamlKeyValue
}

func MergeMaps added in v0.72.0

func MergeMaps(a, b *YamlMap) *YamlMap

func (YamlMap) GetValue

func (ym YamlMap) GetValue(key string) *YamlNode

func (*YamlMap) IsIdentical added in v0.50.0

func (ym *YamlMap) IsIdentical(b *YamlMap) bool

func (YamlMap) Lines

func (ym YamlMap) Lines() (lr diags.LineRange)

type YamlNode

type YamlNode struct {
	Value string
	Pos   diags.PositionRanges
}

func (*YamlNode) IsIdentical added in v0.54.0

func (yn *YamlNode) IsIdentical(b *YamlNode) bool

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL