parser

Documentation

Index

• type AlertingRule
  • func (ar AlertingRule) Comments() (comments []string)
  • func (ar AlertingRule) Lines() (lines []int)
• type Comment
  • func GetComment(line string, comment ...string) (s Comment, ok bool)
  • func (c Comment) String() string
• type Content
  • func ReadContent(r io.Reader) (out Content, err error)
• type FilePosition
  • func NewFilePosition(l []int) FilePosition
  • func (fp FilePosition) FirstLine() (line int)
  • func (fp FilePosition) LastLine() (line int)
• type ParseError
• type Parser
  • func NewParser() Parser
  • func (p Parser) Parse(content []byte) (rules []Rule, err error)
• type PromQLError
  • func (pqle PromQLError) Error() string
  • func (pqle PromQLError) Node() *PromQLNode
  • func (pqle *PromQLError) Unwrap() error
• type PromQLExpr
  • func (pqle PromQLExpr) Lines() (lines []int)
• type PromQLNode
  • func DecodeExpr(expr string) (*PromQLNode, error)
• type RecordingRule
  • func (rr RecordingRule) Comments() (comments []string)
  • func (rr RecordingRule) Lines() (lines []int)
• type Result
• type Rule
  • func (r Rule) Expr() PromQLExpr
  • func (r Rule) GetComment(comment ...string) (s Comment, ok bool)
  • func (r Rule) GetComments(key string) (cs []Comment)
  • func (r Rule) HasComment(comment string) bool
  • func (r Rule) IsSame(nr Rule) bool
  • func (r Rule) LineRange() []int
  • func (r Rule) Lines() []int
• type YamlKeyValue
  • func (ykv YamlKeyValue) Lines() (lines []int)
• type YamlMap
  • func (ym YamlMap) GetValue(key string) *YamlNode
  • func (ym YamlMap) Lines() (lines []int)
• type YamlNode

Types

type AlertingRule

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

func (AlertingRule) Comments

func (ar AlertingRule) Comments() (comments []string)

func (AlertingRule) Lines

func (ar AlertingRule) Lines() (lines []int)

type Comment

type Comment struct {
	Key   string
	Value string
}

func GetComment

func GetComment(line string, comment ...string) (s Comment, ok bool)

func (Comment) String

func (c Comment) String() string

type Content

type Content struct {
	Body    []byte
	Ignored bool
}

func ReadContent

func ReadContent(r io.Reader) (out Content, err error)

type FilePosition

type FilePosition struct {
	Lines []int
}

func NewFilePosition

func NewFilePosition(l []int) FilePosition

func (FilePosition) FirstLine

func (fp FilePosition) FirstLine() (line int)

func (FilePosition) LastLine

func (fp FilePosition) LastLine() (line int)

type ParseError

type ParseError struct {
	Fragment string
	Err      error
	Line     int
}

type Parser

type Parser struct{}

func NewParser

func NewParser() Parser

func (Parser) Parse

func (p Parser) Parse(content []byte) (rules []Rule, err error)

type PromQLError

type PromQLError struct {
	Err error
	// contains filtered or unexported fields
}

func (PromQLError) Error

func (pqle PromQLError) Error() string

func (PromQLError) Node

func (pqle PromQLError) Node() *PromQLNode

func (*PromQLError) Unwrap

func (pqle *PromQLError) Unwrap() error

type PromQLExpr

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

func (PromQLExpr) Lines

func (pqle PromQLExpr) Lines() (lines []int)

type PromQLNode

type PromQLNode struct {
	Expr     string
	Node     promparser.Expr
	Children []*PromQLNode
}

func DecodeExpr

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

type RecordingRule

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

func (RecordingRule) Comments

func (rr RecordingRule) Comments() (comments []string)

func (RecordingRule) Lines

func (rr RecordingRule) Lines() (lines []int)

type Result

type Result struct {
	Path    string
	Error   error
	Content []byte
	Rules   []Rule
}

type Rule

type Rule struct {
	AlertingRule  *AlertingRule
	RecordingRule *RecordingRule
	Error         ParseError
}

func (Rule) Expr

func (r Rule) Expr() PromQLExpr

func (Rule) GetComment

func (r Rule) GetComment(comment ...string) (s Comment, ok bool)

func (Rule) GetComments

func (r Rule) GetComments(key string) (cs []Comment)

func (Rule) HasComment

func (r Rule) HasComment(comment string) bool

func (Rule) IsSame

func (r Rule) IsSame(nr Rule) bool

func (Rule) LineRange

func (r Rule) LineRange() []int

func (Rule) Lines

func (r Rule) Lines() []int

type YamlKeyValue

type YamlKeyValue struct {
	Key   *YamlNode
	Value *YamlNode
}

func (YamlKeyValue) Lines

func (ykv YamlKeyValue) Lines() (lines []int)

type YamlMap

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

func (YamlMap) GetValue

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

func (YamlMap) Lines

func (ym YamlMap) Lines() (lines []int)

type YamlNode

type YamlNode struct {
	Position FilePosition
	Value    string
	Comments []string
}