Files
2026-02-12 23:49:54 +01:00

2492 lines
61 KiB
Go

package metricsql
import (
"fmt"
"strconv"
"strings"
"sync"
)
// Parse parses MetricsQL query s.
//
// All the `WITH` expressions are expanded in the returned Expr.
//
// MetricsQL is backwards-compatible with PromQL.
func Parse(s string) (Expr, error) {
// Parse s
e, err := parseInternal(s)
if err != nil {
return nil, err
}
// Expand `WITH` expressions.
was := getDefaultWithArgExprs()
if e, err = expandWithExpr(was, e); err != nil {
return nil, fmt.Errorf(`cannot expand WITH expressions: %s`, err)
}
e = removeParensExpr(e)
e = simplifyConstants(e)
if err := checkSupportedFunctions(e); err != nil {
return nil, err
}
return e, nil
}
func parseInternal(s string) (Expr, error) {
var p parser
p.lex.Init(s)
if err := p.lex.Next(); err != nil {
return nil, fmt.Errorf(`cannot find the first token: %s`, err)
}
e, err := p.parseExpr()
if err != nil {
return nil, fmt.Errorf(`%s; unparsed data: %q`, err, p.lex.Context())
}
if !isEOF(p.lex.Token) {
return nil, fmt.Errorf(`unparsed data left: %q`, p.lex.Context())
}
return e, nil
}
// Expr holds any of *Expr types.
type Expr interface {
// AppendString appends string representation of Expr to dst.
AppendString(dst []byte) []byte
}
func getDefaultWithArgExprs() []*withArgExpr {
defaultWithArgExprsOnce.Do(func() {
defaultWithArgExprs = prepareWithArgExprs([]string{
// ru - resource utilization
`ru(freev, maxv) = clamp_min(maxv - clamp_min(freev, 0), 0) / clamp_min(maxv, 0) * 100`,
// ttf - time to fuckup
`ttf(freev) = smooth_exponential(
clamp_max(clamp_max(-freev, 0) / clamp_max(deriv_fast(freev), 0), 365*24*3600),
clamp_max(step()/300, 1)
)`,
`range_median(q) = range_quantile(0.5, q)`,
`alias(q, name) = label_set(q, "__name__", name)`,
})
})
return defaultWithArgExprs
}
var (
defaultWithArgExprs []*withArgExpr
defaultWithArgExprsOnce sync.Once
)
func prepareWithArgExprs(ss []string) []*withArgExpr {
was := make([]*withArgExpr, len(ss))
for i, s := range ss {
was[i] = mustParseWithArgExpr(s)
}
if err := checkDuplicateWithArgNames(was); err != nil {
panic(fmt.Errorf("BUG: %s", err))
}
return was
}
func checkDuplicateWithArgNames(was []*withArgExpr) error {
m := make(map[string]*withArgExpr, len(was))
for _, wa := range was {
if waOld := m[wa.Name]; waOld != nil {
return fmt.Errorf("duplicate `with` arg name for: %s; previous one: %s", wa, waOld.AppendString(nil))
}
m[wa.Name] = wa
}
return nil
}
func mustParseWithArgExpr(s string) *withArgExpr {
var p parser
p.lex.Init(s)
if err := p.lex.Next(); err != nil {
panic(fmt.Errorf("BUG: cannot find the first token in %q: %s", s, err))
}
wa, err := p.parseWithArgExpr()
if err != nil {
panic(fmt.Errorf("BUG: cannot parse %q: %s; unparsed data: %q", s, err, p.lex.Context()))
}
return wa
}
// removeParensExpr removes parensExpr for (Expr) case.
func removeParensExpr(e Expr) Expr {
switch t := e.(type) {
case *RollupExpr:
t.Expr = removeParensExpr(t.Expr)
if t.At != nil {
t.At = removeParensExpr(t.At)
}
return t
case *BinaryOpExpr:
t.Left = removeParensExpr(t.Left)
t.Right = removeParensExpr(t.Right)
return t
case *AggrFuncExpr:
for i, arg := range t.Args {
t.Args[i] = removeParensExpr(arg)
}
return t
case *FuncExpr:
for i, arg := range t.Args {
t.Args[i] = removeParensExpr(arg)
}
return t
case *parensExpr:
args := *t
for i, arg := range args {
args[i] = removeParensExpr(arg)
}
if len(*t) == 1 {
return args[0]
}
// Treat parensExpr as a function with empty name, i.e. union()
fe := &FuncExpr{
Name: "",
Args: args,
}
return fe
case *withExpr:
for _, arg := range t.Was {
arg.Expr = removeParensExpr(arg.Expr)
}
t.Expr = removeParensExpr(t.Expr)
return t
default:
return e
}
}
func simplifyConstants(e Expr) Expr {
switch t := e.(type) {
case *withExpr:
panic(fmt.Errorf("BUG: withExpr shouldn't be passed to simplifyConstants"))
case *parensExpr:
panic(fmt.Errorf("BUG: parensExpr shouldn't be passed to simplifyConstants"))
case *RollupExpr:
t.Expr = simplifyConstants(t.Expr)
if t.At != nil {
t.At = simplifyConstants(t.At)
}
return t
case *AggrFuncExpr:
simplifyConstantsInplace(t.Args)
return t
case *FuncExpr:
simplifyConstantsInplace(t.Args)
return t
case *BinaryOpExpr:
return simplifyConstantsInBinaryExpr(t)
default:
return e
}
}
func simplifyConstantsInBinaryExpr(be *BinaryOpExpr) Expr {
be.Left = simplifyConstants(be.Left)
be.Right = simplifyConstants(be.Right)
lne, lok := be.Left.(*NumberExpr)
rne, rok := be.Right.(*NumberExpr)
if lok && rok {
n := binaryOpEvalNumber(be.Op, lne.N, rne.N, be.Bool)
return &NumberExpr{
N: n,
}
}
// Check whether both operands are string literals.
lse, lok := be.Left.(*StringExpr)
rse, rok := be.Right.(*StringExpr)
if !lok || !rok {
return be
}
if be.Op == "+" {
// convert "foo" + "bar" to "foobar".
return &StringExpr{
S: lse.S + rse.S,
}
}
if !IsBinaryOpCmp(be.Op) {
return be
}
// Perform string comparisons.
ok := false
switch be.Op {
case "==":
ok = lse.S == rse.S
case "!=":
ok = lse.S != rse.S
case ">":
ok = lse.S > rse.S
case "<":
ok = lse.S < rse.S
case ">=":
ok = lse.S >= rse.S
case "<=":
ok = lse.S <= rse.S
default:
panic(fmt.Errorf("BUG: unexpected comparison binaryOp: %q", be.Op))
}
n := float64(0)
if ok {
n = 1
}
if !be.Bool && n == 0 {
n = nan
}
return &NumberExpr{
N: n,
}
}
func simplifyConstantsInplace(args []Expr) {
for i, arg := range args {
args[i] = simplifyConstants(arg)
}
}
// parser parses MetricsQL expression.
//
// preconditions for all parser.parse* funcs:
// - p.lex.Token should point to the first token to parse.
//
// postconditions for all parser.parse* funcs:
// - p.lex.Token should point to the next token after the parsed token.
type parser struct {
lex lexer
}
func isWith(s string) bool {
s = strings.ToLower(s)
return s == "with"
}
// parseWithExpr parses `WITH (withArgExpr...) expr`.
func (p *parser) parseWithExpr() (*withExpr, error) {
var we withExpr
if !isWith(p.lex.Token) {
return nil, fmt.Errorf("withExpr: unexpected token %q; want `WITH`", p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token != "(" {
return nil, fmt.Errorf(`withExpr: unexpected token %q; want "("`, p.lex.Token)
}
for {
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == ")" {
goto end
}
wa, err := p.parseWithArgExpr()
if err != nil {
return nil, err
}
we.Was = append(we.Was, wa)
switch p.lex.Token {
case ",":
continue
case ")":
goto end
default:
return nil, fmt.Errorf(`withExpr: unexpected token %q; want ",", ")"`, p.lex.Token)
}
}
end:
if err := checkDuplicateWithArgNames(we.Was); err != nil {
return nil, err
}
if err := p.lex.Next(); err != nil {
return nil, err
}
e, err := p.parseExpr()
if err != nil {
return nil, err
}
we.Expr = e
return &we, nil
}
func (p *parser) parseWithArgExpr() (*withArgExpr, error) {
var wa withArgExpr
if !isIdentPrefix(p.lex.Token) {
return nil, fmt.Errorf(`withArgExpr: unexpected token %q; want "ident"`, p.lex.Token)
}
wa.Name = unescapeIdent(p.lex.Token)
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == "(" {
// Parse func args.
args, err := p.parseIdentList(false)
if err != nil {
return nil, fmt.Errorf(`withArgExpr: cannot parse args for %q: %s`, wa.Name, err)
}
// Make sure all the args have different names
m := make(map[string]bool, len(args))
for _, arg := range args {
if m[arg] {
return nil, fmt.Errorf(`withArgExpr: duplicate func arg found in %q: %q`, wa.Name, arg)
}
m[arg] = true
}
wa.Args = args
}
if p.lex.Token != "=" {
return nil, fmt.Errorf(`withArgExpr: unexpected token %q; want "="`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
e, err := p.parseExpr()
if err != nil {
return nil, fmt.Errorf(`withArgExpr: cannot parse %q: %s`, wa.Name, err)
}
wa.Expr = e
return &wa, nil
}
func (p *parser) parseExpr() (Expr, error) {
e, err := p.parseSingleExpr()
if err != nil {
return nil, err
}
for {
if !isBinaryOp(p.lex.Token) {
return e, nil
}
var be BinaryOpExpr
be.Op = strings.ToLower(p.lex.Token)
be.Left = e
if err := p.lex.Next(); err != nil {
return nil, err
}
if isBinaryOpBoolModifier(p.lex.Token) {
if !IsBinaryOpCmp(be.Op) {
return nil, fmt.Errorf(`bool modifier cannot be applied to %q`, be.Op)
}
be.Bool = true
if err := p.lex.Next(); err != nil {
return nil, err
}
}
if isBinaryOpGroupModifier(p.lex.Token) {
if err := p.parseModifierExpr(&be.GroupModifier, false); err != nil {
return nil, err
}
if isBinaryOpJoinModifier(p.lex.Token) {
if isBinaryOpLogicalSet(be.Op) {
return nil, fmt.Errorf(`modifier %q cannot be applied to %q`, p.lex.Token, be.Op)
}
if err := p.parseModifierExpr(&be.JoinModifier, true); err != nil {
return nil, err
}
if isPrefixModifier(p.lex.Token) {
if err := p.lex.Next(); err != nil {
return nil, fmt.Errorf("cannot read prefix for %s: %w", be.JoinModifier.AppendString(nil), err)
}
se, err := p.parseStringExpr()
if err != nil {
return nil, fmt.Errorf("cannot parse prefix for %s: %w", be.JoinModifier.AppendString(nil), err)
}
be.JoinModifierPrefix = se
}
}
}
e2, err := p.parseSingleExpr()
if err != nil {
return nil, err
}
be.Right = e2
if isKeepMetricNames(p.lex.Token) {
be.KeepMetricNames = true
if err := p.lex.Next(); err != nil {
return nil, err
}
}
e = balanceBinaryOp(&be)
}
}
func balanceBinaryOp(be *BinaryOpExpr) Expr {
bel, ok := be.Left.(*BinaryOpExpr)
if !ok {
return be
}
lp := binaryOpPriority(bel.Op)
rp := binaryOpPriority(be.Op)
if rp < lp {
return be
}
if rp == lp && !isRightAssociativeBinaryOp(be.Op) {
return be
}
be.Left = bel.Right
bel.Right = balanceBinaryOp(be)
return bel
}
// parseSingleExpr parses non-binaryOp expressions.
func (p *parser) parseSingleExpr() (Expr, error) {
if isWith(p.lex.Token) {
err := p.lex.Next()
nextToken := p.lex.Token
p.lex.Prev()
if err == nil && nextToken == "(" {
return p.parseWithExpr()
}
}
e, err := p.parseSingleExprWithoutRollupSuffix()
if err != nil {
return nil, err
}
if !isRollupStartToken(p.lex.Token) {
// There is no rollup expression.
return e, nil
}
return p.parseRollupExpr(e)
}
func isRollupStartToken(token string) bool {
return token == "[" || token == "@" || isOffset(token)
}
func (p *parser) parseSingleExprWithoutRollupSuffix() (Expr, error) {
if isPositiveDuration(p.lex.Token) {
return p.parsePositiveDuration()
}
if isStringPrefix(p.lex.Token) {
return p.parseStringExpr()
}
if isPositiveNumberPrefix(p.lex.Token) || isInfOrNaN(p.lex.Token) {
return p.parsePositiveNumberExpr()
}
if isIdentPrefix(p.lex.Token) {
return p.parseIdentExpr()
}
switch p.lex.Token {
case "(":
return p.parseParensExpr()
case "{":
return p.parseMetricExpr()
case "-":
// Unary minus. Substitute `-expr` with `0 - expr`
if err := p.lex.Next(); err != nil {
return nil, err
}
e, err := p.parseSingleExpr()
if err != nil {
return nil, err
}
be := &BinaryOpExpr{
Op: "-",
Left: &NumberExpr{
N: 0,
},
Right: e,
}
return be, nil
case "+":
// Unary plus
if err := p.lex.Next(); err != nil {
return nil, err
}
return p.parseSingleExpr()
default:
return nil, fmt.Errorf(`singleExpr: unexpected token %q; want "(", "{", "-", "+"`, p.lex.Token)
}
}
func (p *parser) parsePositiveNumberExpr() (*NumberExpr, error) {
if !isPositiveNumberPrefix(p.lex.Token) && !isInfOrNaN(p.lex.Token) {
return nil, fmt.Errorf(`positiveNumberExpr: unexpected token %q; want "number"`, p.lex.Token)
}
s := p.lex.Token
n, err := parsePositiveNumber(s)
if err != nil {
return nil, fmt.Errorf(`positivenumberExpr: cannot parse %q: %s`, s, err)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
ne := &NumberExpr{
N: n,
s: s,
}
return ne, nil
}
func (p *parser) parseStringExpr() (*StringExpr, error) {
var se StringExpr
for {
switch {
case isStringPrefix(p.lex.Token) || isIdentPrefix(p.lex.Token):
se.tokens = append(se.tokens, p.lex.Token)
default:
return nil, fmt.Errorf(`StringExpr: unexpected token %q; want "string"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token != "+" {
return &se, nil
}
// composite StringExpr like `"s1" + "s2"`, `"s" + m()` or `"s" + m{}` or `"s" + unknownToken`.
if err := p.lex.Next(); err != nil {
return nil, err
}
if isStringPrefix(p.lex.Token) {
// "s1" + "s2"
continue
}
if !isIdentPrefix(p.lex.Token) {
// "s" + unknownToken
p.lex.Prev()
return &se, nil
}
// Look after ident
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == "(" || p.lex.Token == "{" {
// `"s" + m(` or `"s" + m{`
p.lex.Prev()
p.lex.Prev()
return &se, nil
}
// "s" + ident
p.lex.Prev()
}
}
func (p *parser) parseParensExpr() (*parensExpr, error) {
if p.lex.Token != "(" {
return nil, fmt.Errorf(`parensExpr: unexpected token %q; want "("`, p.lex.Token)
}
var exprs []Expr
for {
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == ")" {
break
}
expr, err := p.parseExpr()
if err != nil {
return nil, err
}
exprs = append(exprs, expr)
if p.lex.Token == "," {
continue
}
if p.lex.Token == ")" {
break
}
return nil, fmt.Errorf(`parensExpr: unexpected token %q; want "," or ")"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if len(exprs) == 1 {
if be, ok := exprs[0].(*BinaryOpExpr); ok && isKeepMetricNames(p.lex.Token) {
if err := p.lex.Next(); err != nil {
return nil, err
}
be.KeepMetricNames = true
}
}
pe := parensExpr(exprs)
return &pe, nil
}
func (p *parser) parseAggrFuncExpr() (*AggrFuncExpr, error) {
if !IsAggrFunc(p.lex.Token) {
return nil, fmt.Errorf(`AggrFuncExpr: unexpected token %q; want aggregate func`, p.lex.Token)
}
var ae AggrFuncExpr
ae.Name = strings.ToLower(unescapeIdent(p.lex.Token))
if err := p.lex.Next(); err != nil {
return nil, err
}
if isIdentPrefix(p.lex.Token) {
goto funcPrefixLabel
}
if p.lex.Token == "(" {
goto funcArgsLabel
}
return nil, fmt.Errorf(`AggrFuncExpr: unexpected token %q; want "("`, p.lex.Token)
funcPrefixLabel:
{
if !isAggrFuncModifier(p.lex.Token) {
return nil, fmt.Errorf(`AggrFuncExpr: unexpected token %q; want aggregate func modifier`, p.lex.Token)
}
if err := p.parseModifierExpr(&ae.Modifier, false); err != nil {
return nil, err
}
}
funcArgsLabel:
{
args, err := p.parseArgListExpr()
if err != nil {
return nil, err
}
ae.Args = args
// Verify whether func suffix exists.
if ae.Modifier.Op == "" && isAggrFuncModifier(p.lex.Token) {
if err := p.parseModifierExpr(&ae.Modifier, false); err != nil {
return nil, err
}
}
// Check for optional limit.
if strings.ToLower(p.lex.Token) == "limit" {
if err := p.lex.Next(); err != nil {
return nil, err
}
limit, err := strconv.Atoi(p.lex.Token)
if err != nil {
return nil, fmt.Errorf("cannot parse limit %q: %s", p.lex.Token, err)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
ae.Limit = limit
}
return &ae, nil
}
}
func expandWithExpr(was []*withArgExpr, e Expr) (Expr, error) {
switch t := e.(type) {
case *BinaryOpExpr:
left, err := expandWithExpr(was, t.Left)
if err != nil {
return nil, err
}
right, err := expandWithExpr(was, t.Right)
if err != nil {
return nil, err
}
groupModifierArgs, err := expandModifierArgs(was, t.GroupModifier.Args)
if err != nil {
return nil, err
}
joinModifierArgs, err := expandModifierArgs(was, t.JoinModifier.Args)
if err != nil {
return nil, err
}
var joinModifierPrefix *StringExpr
if t.JoinModifierPrefix != nil {
jmp, err := expandWithExpr(was, t.JoinModifierPrefix)
if err != nil {
return nil, err
}
se, ok := jmp.(*StringExpr)
if !ok {
return nil, fmt.Errorf("unexpected prefix for %s; want quoted string; got %s", t.JoinModifier.AppendString(nil), jmp.AppendString(nil))
}
joinModifierPrefix = se
}
if t.Op == "+" {
lse, lok := left.(*StringExpr)
rse, rok := right.(*StringExpr)
if lok && rok {
se := &StringExpr{
S: lse.S + rse.S,
}
return se, nil
}
}
be := *t
be.Left = left
be.Right = right
be.GroupModifier.Args = groupModifierArgs
be.JoinModifier.Args = joinModifierArgs
be.JoinModifierPrefix = joinModifierPrefix
pe := parensExpr{&be}
return &pe, nil
case *FuncExpr:
args, err := expandWithArgs(was, t.Args)
if err != nil {
return nil, err
}
wa := getWithArgExpr(was, t.Name)
if wa != nil {
return expandWithExprExt(was, wa, args)
}
fe := *t
fe.Args = args
return &fe, nil
case *AggrFuncExpr:
args, err := expandWithArgs(was, t.Args)
if err != nil {
return nil, err
}
wa := getWithArgExpr(was, t.Name)
if wa != nil {
return expandWithExprExt(was, wa, args)
}
modifierArgs, err := expandModifierArgs(was, t.Modifier.Args)
if err != nil {
return nil, err
}
ae := *t
ae.Args = args
ae.Modifier.Args = modifierArgs
return &ae, nil
case *parensExpr:
exprs, err := expandWithArgs(was, *t)
if err != nil {
return nil, err
}
pe := parensExpr(exprs)
return &pe, nil
case *StringExpr:
if len(t.S) > 0 {
// Already expanded.
return t, nil
}
var b []byte
for _, token := range t.tokens {
if isStringPrefix(token) {
s, err := extractStringValue(token)
if err != nil {
return nil, err
}
b = append(b, s...)
continue
}
wa := getWithArgExpr(was, token)
if wa == nil {
return nil, fmt.Errorf("missing %q value inside StringExpr", token)
}
eNew, err := expandWithExprExt(was, wa, nil)
if err != nil {
return nil, err
}
seSrc, ok := eNew.(*StringExpr)
if !ok {
return nil, fmt.Errorf("%q must be string expression; got %q", token, eNew.AppendString(nil))
}
if len(seSrc.tokens) > 0 {
panic(fmt.Errorf("BUG: seSrc.tokens must be empty; got %q", seSrc.tokens))
}
b = append(b, seSrc.S...)
}
se := &StringExpr{
S: string(b),
}
return se, nil
case *RollupExpr:
eNew, err := expandWithExpr(was, t.Expr)
if err != nil {
return nil, err
}
re := *t
re.Expr = eNew
re.Window, err = expandDuration(was, re.Window)
if err != nil {
return nil, fmt.Errorf("cannot parse window for %s: %w", re.Expr.AppendString(nil), err)
}
re.Step, err = expandDuration(was, re.Step)
if err != nil {
return nil, fmt.Errorf("cannot parse step in %s: %w", re.Expr.AppendString(nil), err)
}
re.Offset, err = expandDuration(was, re.Offset)
if err != nil {
return nil, fmt.Errorf("cannot parse offset in %s: %w", re.Expr.AppendString(nil), err)
}
if t.At != nil {
atNew, err := expandWithExpr(was, t.At)
if err != nil {
return nil, err
}
re.At = atNew
}
return &re, nil
case *withExpr:
wasNew := make([]*withArgExpr, 0, len(was)+len(t.Was))
wasNew = append(wasNew, was...)
wasNew = append(wasNew, t.Was...)
eNew, err := expandWithExpr(wasNew, t.Expr)
if err != nil {
return nil, err
}
return eNew, nil
case *MetricExpr:
if len(t.labelFilterss) == 0 {
// Already expanded.
return t, nil
}
{
var me MetricExpr
// Populate me.LabelFilterss
// Find out if all or-subclauses that specify a metric name agree on one
// NB: cannot use a guard value because metric names can be any string
commonMetricName := ""
haveCommonMetric := true
for _, lfes := range t.labelFilterss {
localMetricName := ""
var lfsNew []LabelFilter
for _, lfe := range lfes {
if lfe.Value == nil {
// Expand lfe.Label into lfsNew.
wa := getWithArgExpr(was, lfe.Label)
if wa == nil {
// Check to see if this is a possible metric name
// This means label name set and starts and ends with quotes
// but value is nil
if lfe.IsPossibleMetricName {
var err error
if lfsNew, localMetricName, err = checkAndPrependMetricNameFilter(lfsNew, localMetricName, lfe.Label); err != nil {
return nil, err
}
continue
}
return nil, fmt.Errorf("cannot find WITH template for %q inside %q", lfe.Label, t.AppendString(nil))
}
eNew, err := expandWithExprExt(was, wa, []Expr{})
if err != nil {
return nil, err
}
wme, ok := eNew.(*MetricExpr)
if !ok || wme.getMetricName() != "" {
return nil, fmt.Errorf("WITH template %q inside %q must be {...}; got %q",
lfe.Label, t.AppendString(nil), eNew.AppendString(nil))
}
if len(wme.labelFilterss) > 0 {
panic(fmt.Errorf("BUG: wme.labelFilterss must be empty after WITH template expansion; got %s", wme.AppendString(nil)))
}
lfssSrc := wme.LabelFilterss
if len(lfssSrc) > 1 {
return nil, fmt.Errorf("WITH template %q at %q must be {...} without 'or'; got %s",
lfe.Label, t.AppendString(nil), wme.AppendString(nil))
}
if len(lfssSrc) == 1 {
lfsNew = append(lfsNew, lfssSrc[0]...)
}
continue
}
// convert lfe to LabelFilter.
se, err := expandWithExpr(was, lfe.Value)
if err != nil {
return nil, err
}
var lfeNew labelFilterExpr
lfeNew.Label = lfe.Label
lfeNew.Value = se.(*StringExpr)
lfeNew.IsNegative = lfe.IsNegative
lfeNew.IsRegexp = lfe.IsRegexp
lf, err := lfeNew.toLabelFilter()
if err != nil {
return nil, err
}
if lf.isMetricNameFilter() {
if lfsNew, localMetricName, err = checkAndPrependMetricNameFilter(lfsNew, localMetricName, lf.Value); err != nil {
return nil, err
}
} else {
lfsNew = append(lfsNew, *lf)
}
}
if haveCommonMetric && localMetricName != "" {
if commonMetricName == "" {
commonMetricName = localMetricName
} else if commonMetricName != localMetricName {
haveCommonMetric = false
}
}
lfsNew = removeDuplicateLabelFilters(lfsNew)
me.LabelFilterss = append(me.LabelFilterss, lfsNew)
}
// If all or-subclauses that specify a metric name agree on one, prepend it to clauses
// where __name__ is missing entirely (incuding regexes and negatives)
if haveCommonMetric && commonMetricName != "" {
for i, lfs := range me.LabelFilterss {
haveNameClause := false
for _, lf := range lfs {
if lf.Label == "__name__" {
haveNameClause = true
break
}
}
if !haveNameClause {
me.LabelFilterss[i] = prependMetricNameFilter(lfs, commonMetricName)
}
}
}
t = &me
}
metricName := t.getMetricName()
if metricName == "" {
return t, nil
}
wa := getWithArgExpr(was, metricName)
if wa == nil {
return t, nil
}
eNew, err := expandWithExprExt(was, wa, nil)
if err != nil {
return nil, err
}
var wme *MetricExpr
re, _ := eNew.(*RollupExpr)
if re != nil {
wme, _ = re.Expr.(*MetricExpr)
} else {
wme, _ = eNew.(*MetricExpr)
}
if wme == nil {
if t.isOnlyMetricName() {
return eNew, nil
}
return nil, fmt.Errorf("cannot expand %q to non-metric expression %q", t.AppendString(nil), eNew.AppendString(nil))
}
if len(wme.labelFilterss) > 0 {
panic(fmt.Errorf("BUG: wme.labelFilterss must be empty after WITH templates expansion; got %s", wme.AppendString(nil)))
}
lfssSrc := wme.LabelFilterss
var lfssNew [][]LabelFilter
if len(lfssSrc) != 1 {
// template_name{filters} where template_name is {... or ...}
if t.isOnlyMetricName() {
// {filters} is empty. Return {... or ...}
return eNew, nil
}
if len(t.LabelFilterss) != 1 {
// {filters} contain {... or ...}. It cannot be merged with {... or ...}
return nil, fmt.Errorf("%q mustn't contain 'or' filters; got %s", metricName, wme.AppendString(nil))
}
// {filters} doesn't contain `or`. Merge it with {... or ...} into {...,filters or ...,filters}
for _, lfs := range lfssSrc {
lfsNew := append([]LabelFilter{}, lfs...)
lfsNew = append(lfsNew, t.LabelFilterss[0][1:]...)
lfsNew = removeDuplicateLabelFilters(lfsNew)
lfssNew = append(lfssNew, lfsNew)
}
} else {
// template_name{... or ...} where template_name is an ordinary {filters} without 'or'.
// Merge it into {filters,... or filters,...}
for _, lfs := range t.LabelFilterss {
lfsNew := append([]LabelFilter{}, lfssSrc[0]...)
lfsNew = append(lfsNew, lfs[1:]...)
lfsNew = removeDuplicateLabelFilters(lfsNew)
lfssNew = append(lfssNew, lfsNew)
}
}
me := &MetricExpr{
LabelFilterss: lfssNew,
}
if re == nil {
return me, nil
}
reNew := *re
reNew.Expr = me
return &reNew, nil
default:
return e, nil
}
}
func checkAndPrependMetricNameFilter(lfs []LabelFilter, metricName string, newMetricName string) ([]LabelFilter, string, error) {
if metricName != "" && metricName != newMetricName {
return nil, "", fmt.Errorf("parse error: metric name must not be set twice: %q or %q", metricName, newMetricName)
}
return prependMetricNameFilter(lfs, newMetricName), newMetricName, nil
}
func prependMetricNameFilter(lfs []LabelFilter, metricName string) []LabelFilter {
var lf LabelFilter
lf.Label = "__name__"
lf.Value = metricName
return append([]LabelFilter{lf}, lfs...)
}
func expandWithArgs(was []*withArgExpr, args []Expr) ([]Expr, error) {
dstArgs := make([]Expr, len(args))
for i, arg := range args {
dstArg, err := expandWithExpr(was, arg)
if err != nil {
return nil, err
}
dstArgs[i] = dstArg
}
return dstArgs, nil
}
func expandDuration(was []*withArgExpr, d *DurationExpr) (*DurationExpr, error) {
if d == nil {
return nil, nil
}
if !d.needsParsing {
return d, nil
}
wa := getWithArgExpr(was, d.s)
if wa == nil {
return nil, fmt.Errorf("cannot find WITH template for %q", d.s)
}
e, err := expandWithExprExt(was, wa, []Expr{})
if err != nil {
return nil, err
}
switch t := e.(type) {
case *DurationExpr:
if t.needsParsing {
panic(fmt.Errorf("BUG: DurationExpr %q must be already parsed", t.s))
}
return t, nil
case *NumberExpr:
// Convert number of seconds to DurationExpr
return newDurationExpr(t.s)
default:
return nil, fmt.Errorf("unexpected value for WITH template %q; got %s; want duration", d.s, e.AppendString(nil))
}
}
func expandModifierArgs(was []*withArgExpr, args []string) ([]string, error) {
if len(args) == 0 {
return nil, nil
}
dstArgs := make([]string, 0, len(args))
for _, arg := range args {
wa := getWithArgExpr(was, arg)
if wa == nil {
// Leave the arg as is.
dstArgs = append(dstArgs, arg)
continue
}
if len(wa.Args) > 0 {
// Template funcs cannot be used inside modifier list. Leave the arg as is.
dstArgs = append(dstArgs, arg)
continue
}
me, ok := wa.Expr.(*MetricExpr)
if ok {
if !me.isOnlyMetricName() {
return nil, fmt.Errorf("cannot use %q instead of %q in %s", me.AppendString(nil), arg, args)
}
metricName := me.getMetricName()
dstArgs = append(dstArgs, metricName)
continue
}
pe, ok := wa.Expr.(*parensExpr)
if ok {
for _, pArg := range *pe {
me, ok := pArg.(*MetricExpr)
if !ok || !me.isOnlyMetricName() {
return nil, fmt.Errorf("cannot use %q instead of %q in %s", pe.AppendString(nil), arg, args)
}
metricName := me.getMetricName()
dstArgs = append(dstArgs, metricName)
}
continue
}
return nil, fmt.Errorf("cannot use %q instead of %q in %s", wa.Expr.AppendString(nil), arg, args)
}
// Remove duplicate args from dstArgs
m := make(map[string]bool, len(dstArgs))
filteredArgs := dstArgs[:0]
for _, arg := range dstArgs {
if !m[arg] {
filteredArgs = append(filteredArgs, arg)
m[arg] = true
}
}
return filteredArgs, nil
}
func expandWithExprExt(was []*withArgExpr, wa *withArgExpr, args []Expr) (Expr, error) {
if len(wa.Args) != len(args) {
if args == nil {
// This case is possible if metric name clashes with one of the WITH template name.
//
// In this case just return MetricExpr with the wa.Name name.
return newMetricExpr(wa.Name), nil
}
return nil, fmt.Errorf("invalid number of args for %q; got %d; want %d", wa.Name, len(args), len(wa.Args))
}
wasNew := make([]*withArgExpr, 0, len(was)+len(args))
for _, waTmp := range was {
if waTmp == wa {
break
}
wasNew = append(wasNew, waTmp)
}
for i, arg := range args {
wasNew = append(wasNew, &withArgExpr{
Name: wa.Args[i],
Expr: arg,
})
}
return expandWithExpr(wasNew, wa.Expr)
}
func newMetricExpr(name string) *MetricExpr {
return &MetricExpr{
LabelFilterss: [][]LabelFilter{
{
{
Label: "__name__",
Value: name,
},
},
},
}
}
func extractStringValue(token string) (string, error) {
if !isStringPrefix(token) {
return "", fmt.Errorf(`StringExpr must contain only string literals; got %q`, token)
}
// See https://prometheus.io/docs/prometheus/latest/querying/basics/#string-literals
if token[0] == '\'' {
if len(token) < 2 || token[len(token)-1] != '\'' {
return "", fmt.Errorf(`string literal contains unexpected trailing char; got %q`, token)
}
token = token[1 : len(token)-1]
token = strings.Replace(token, "\\'", "'", -1)
token = strings.Replace(token, `"`, `\"`, -1)
token = `"` + token + `"`
}
s, err := strconv.Unquote(token)
if err != nil {
return "", fmt.Errorf(`cannot parse string literal %q: %s`, token, err)
}
return s, nil
}
func removeDuplicateLabelFilters(lfs []LabelFilter) []LabelFilter {
lfsm := make(map[string]bool, len(lfs))
lfsNew := lfs[:0]
var buf []byte
for i := range lfs {
lf := &lfs[i]
buf = lf.AppendString(buf[:0])
if lfsm[string(buf)] {
continue
}
lfsm[string(buf)] = true
lfsNew = append(lfsNew, *lf)
}
return lfsNew
}
func (p *parser) parseFuncExpr() (*FuncExpr, error) {
if !isIdentPrefix(p.lex.Token) {
return nil, fmt.Errorf(`FuncExpr: unexpected token %q; want "ident"`, p.lex.Token)
}
var fe FuncExpr
fe.Name = unescapeIdent(p.lex.Token)
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token != "(" {
return nil, fmt.Errorf(`FuncExpr; unexpected token %q; want "("`, p.lex.Token)
}
args, err := p.parseArgListExpr()
if err != nil {
return nil, err
}
fe.Args = args
if isKeepMetricNames(p.lex.Token) {
fe.KeepMetricNames = true
if err := p.lex.Next(); err != nil {
return nil, err
}
}
return &fe, nil
}
func isKeepMetricNames(token string) bool {
token = strings.ToLower(token)
return token == "keep_metric_names"
}
func (p *parser) parseModifierExpr(me *ModifierExpr, allowStar bool) error {
if !isIdentPrefix(p.lex.Token) {
return fmt.Errorf(`ModifierExpr: unexpected token %q; want "ident"`, p.lex.Token)
}
me.Op = strings.ToLower(p.lex.Token)
if err := p.lex.Next(); err != nil {
return err
}
if isBinaryOpJoinModifier(me.Op) && p.lex.Token != "(" {
// join modifier may miss ident list.
return nil
}
args, err := p.parseIdentList(allowStar)
if err != nil {
return fmt.Errorf("ModifierExpr: %w", err)
}
me.Args = args
return nil
}
func (p *parser) parseIdentList(allowStar bool) ([]string, error) {
if p.lex.Token != "(" {
return nil, fmt.Errorf(`identList: unexpected token %q; want "("`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if allowStar && p.lex.Token == "*" {
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token != ")" {
return nil, fmt.Errorf(`identList: unexpected token %q after "*"; want ")"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
return []string{"*"}, nil
}
var idents []string
for {
if p.lex.Token == ")" {
if err := p.lex.Next(); err != nil {
return nil, err
}
return idents, nil
}
if isQuotedString(p.lex.Token) {
// indent could be quoted according to prometheus utf-8 encoding
// https://github.com/prometheus/proposals/blob/main/proposals/2023-08-21-utf8.md
p.lex.Token = p.lex.Token[1 : len(p.lex.Token)-1]
}
if !isIdentPrefix(p.lex.Token) {
return nil, fmt.Errorf(`identList: unexpected token %q; want "ident"`, p.lex.Token)
}
idents = append(idents, unescapeIdent(p.lex.Token))
if err := p.lex.Next(); err != nil {
return nil, err
}
switch p.lex.Token {
case ",":
if err := p.lex.Next(); err != nil {
return nil, err
}
case ")":
continue
default:
return nil, fmt.Errorf(`identList: unexpected token %q; want ",", ")"`, p.lex.Token)
}
}
}
func (p *parser) parseArgListExpr() ([]Expr, error) {
if p.lex.Token != "(" {
return nil, fmt.Errorf(`argList: unexpected token %q; want "("`, p.lex.Token)
}
var args []Expr
for {
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == ")" {
goto closeParensLabel
}
expr, err := p.parseExpr()
if err != nil {
return nil, err
}
args = append(args, expr)
switch p.lex.Token {
case ",":
continue
case ")":
goto closeParensLabel
default:
return nil, fmt.Errorf(`argList: unexpected token %q; want ",", ")"`, p.lex.Token)
}
}
closeParensLabel:
if err := p.lex.Next(); err != nil {
return nil, err
}
return args, nil
}
func getWithArgExpr(was []*withArgExpr, name string) *withArgExpr {
// Scan wes backwards, since certain expressions may override
// previously defined expressions
for i := len(was) - 1; i >= 0; i-- {
wa := was[i]
if wa.Name == name {
return wa
}
}
return nil
}
func (p *parser) parseLabelFilterss(mf *labelFilterExpr) ([][]*labelFilterExpr, error) {
if p.lex.Token != "{" {
return nil, fmt.Errorf(`labelFilters: unexpected token %q; want "{"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == "}" {
if err := p.lex.Next(); err != nil {
return nil, err
}
if mf != nil {
return [][]*labelFilterExpr{{mf}}, nil
}
return nil, nil
}
var lfess [][]*labelFilterExpr
for {
lfes, err := p.parseLabelFilters(mf)
if err != nil {
return nil, err
}
lfess = append(lfess, lfes)
switch strings.ToLower(p.lex.Token) {
case "}":
if err := p.lex.Next(); err != nil {
return nil, err
}
return lfess, nil
case "or":
if err := p.lex.Next(); err != nil {
return nil, err
}
}
}
}
func (p *parser) parseLabelFilters(mf *labelFilterExpr) ([]*labelFilterExpr, error) {
var lfes []*labelFilterExpr
if mf != nil {
lfes = append(lfes, mf)
}
for {
lfe, err := p.parseLabelFilterExpr()
if err != nil {
return nil, err
}
lfes = append(lfes, lfe)
switch strings.ToLower(p.lex.Token) {
case ",":
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token == "}" {
return lfes, nil
}
continue
case "or", "}":
return lfes, nil
default:
return nil, fmt.Errorf(`labelFilters: unexpected token %q; want ",", "or", "}"`, p.lex.Token)
}
}
}
func isQuotedString(s string) bool {
if isStringPrefix(s) && isStringPrefix(s[len(s)-1:]) {
return true
}
return false
}
func (p *parser) parseLabelFilterExpr() (*labelFilterExpr, error) {
var isPossibleMetricName bool
if isQuotedString(p.lex.Token) {
// strip quotes
p.lex.Token = p.lex.Token[1 : len(p.lex.Token)-1]
// quoted string could be a metric name: {"metric_name"}
isPossibleMetricName = true
} else if !isIdentPrefix(p.lex.Token) {
return nil, fmt.Errorf(`labelFilterExpr: unexpected token %q; want "ident"`, p.lex.Token)
}
var lfe labelFilterExpr
lfe.Label = unescapeIdent(p.lex.Token)
if err := p.lex.Next(); err != nil {
return nil, err
}
switch strings.ToLower(p.lex.Token) {
case "=":
// Nothing to do.
case "!=":
lfe.IsNegative = true
case "=~":
lfe.IsRegexp = true
case "!~":
lfe.IsNegative = true
lfe.IsRegexp = true
case ",", "}", "or":
// Incomplete label filter 'lf' in the following forms:
//
// - {lf}
// - {lf,other="filter"}
// - {lf or other="filter"}
//
// It must be substituted by complete label filter during WITH template expand.
// If we have a label name that is quoted with a nil value it is possible it's the metric
// name as per Prometheus 3.0 UTF8 quoted label names specifications, this is used later
// in our expanding of the with statements
// https://github.com/prometheus/proposals/blob/main/proposals/2023-08-21-utf8.md
lfe.IsPossibleMetricName = isPossibleMetricName
return &lfe, nil
default:
return nil, fmt.Errorf(`labelFilterExpr: unexpected token %q; want "=", "!=", "=~", "!~", ",", "or", "}"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
se, err := p.parseStringExpr()
if err != nil {
return nil, err
}
lfe.Value = se
return &lfe, nil
}
// labelFilterExpr represents `foo <op> "bar"` expression, where <op> is `=`, `!=`, `=~` or `!~`.
//
// This type isn't exported.
type labelFilterExpr struct {
// Label contains either the label name or the WITH template reference.
Label string
// Value can be nil if Label contains unexpanded WITH template reference.
Value *StringExpr
IsRegexp bool
IsNegative bool
IsPossibleMetricName bool
}
func (lfe *labelFilterExpr) AppendString(dst []byte) []byte {
dst = ifEscapedCharsAppendQuotedIdent(dst, lfe.Label)
if lfe.Value == nil {
return dst
}
dst = appendLabelFilterOp(dst, lfe.IsNegative, lfe.IsRegexp)
tokens := lfe.Value.tokens
if len(tokens) == 0 {
dst = strconv.AppendQuote(dst, lfe.Value.S)
return dst
}
for i, token := range tokens {
dst = append(dst, token...)
if i+1 < len(tokens) {
dst = append(dst, '+')
}
}
return dst
}
func (lfe *labelFilterExpr) toLabelFilter() (*LabelFilter, error) {
if lfe.Value == nil || len(lfe.Value.tokens) > 0 {
panic(fmt.Errorf("BUG: lfe.Value must be already expanded; got %v", lfe.Value))
}
var lf LabelFilter
lf.Label = lfe.Label
lf.Value = lfe.Value.S
lf.IsRegexp = lfe.IsRegexp
lf.IsNegative = lfe.IsNegative
if !lf.IsRegexp {
return &lf, nil
}
// Verify regexp.
if _, err := CompileRegexpAnchored(lfe.Value.S); err != nil {
return nil, fmt.Errorf("invalid regexp in %s=%q: %s", lf.Label, lf.Value, err)
}
return &lf, nil
}
func (p *parser) parseWindowAndStep() (*DurationExpr, *DurationExpr, bool, error) {
if p.lex.Token != "[" {
return nil, nil, false, fmt.Errorf(`windowAndStep: unexpected token %q; want "["`, p.lex.Token)
}
err := p.lex.Next()
if err != nil {
return nil, nil, false, err
}
var window *DurationExpr
if !strings.HasPrefix(p.lex.Token, ":") {
if p.lex.Token == "$__interval" {
// Skip $__interval, since it must be treated as missing lookbehind window,
// e.g. rate(m[$__interval]) must be equivalent to rate(m).
// In this case VictoriaMetrics automatically adjusts the lookbehind window
// to the interval between samples.
err = p.lex.Next()
} else {
window, err = p.parsePositiveDuration()
}
if err != nil {
return nil, nil, false, err
}
}
var step *DurationExpr
inheritStep := false
if strings.HasPrefix(p.lex.Token, ":") {
// Parse step
p.lex.Token = p.lex.Token[1:]
if p.lex.Token == "" {
if err := p.lex.Next(); err != nil {
return nil, nil, false, err
}
if p.lex.Token == "]" {
inheritStep = true
}
}
if p.lex.Token != "]" {
step, err = p.parsePositiveDuration()
if err != nil {
return nil, nil, false, err
}
}
}
if p.lex.Token != "]" {
return nil, nil, false, fmt.Errorf(`windowAndStep: unexpected token %q; want "]"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, nil, false, err
}
return window, step, inheritStep, nil
}
func (p *parser) parseAtExpr() (Expr, error) {
if p.lex.Token != "@" {
return nil, fmt.Errorf(`unexpected token %q; want "@"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
e, err := p.parseSingleExprWithoutRollupSuffix()
if err != nil {
return nil, fmt.Errorf("cannot parse `@` expresion: %w", err)
}
return e, nil
}
func (p *parser) parseOffset() (*DurationExpr, error) {
if !isOffset(p.lex.Token) {
return nil, fmt.Errorf(`offset: unexpected token %q; want "offset"`, p.lex.Token)
}
if err := p.lex.Next(); err != nil {
return nil, err
}
de, err := p.parseDuration()
if err != nil {
return nil, err
}
return de, nil
}
func (p *parser) parseDuration() (*DurationExpr, error) {
isNegative := p.lex.Token == "-"
if isNegative {
if err := p.lex.Next(); err != nil {
return nil, err
}
}
de, err := p.parsePositiveDuration()
if err != nil {
return nil, err
}
if isNegative {
de.s = "-" + de.s
}
return de, nil
}
func (p *parser) parsePositiveDuration() (*DurationExpr, error) {
s := p.lex.Token
if isIdentPrefix(s) {
n := strings.IndexByte(s, ':')
if n >= 0 {
p.lex.PushBack(s[:n], s[n:])
s = s[:n]
}
if err := p.lex.Next(); err != nil {
return nil, err
}
de := &DurationExpr{
s: s,
needsParsing: true,
}
return de, nil
}
if isPositiveDuration(s) {
if err := p.lex.Next(); err != nil {
return nil, err
}
} else {
if !isPositiveNumberPrefix(s) {
return nil, fmt.Errorf(`duration: unexpected token %q; want valid duration`, s)
}
// Verify the duration in seconds without explicit suffix.
if _, err := p.parsePositiveNumberExpr(); err != nil {
return nil, fmt.Errorf(`duration: parse error: %s`, err)
}
}
// Verify duration value.
if s == "$__interval" {
s = "1i"
}
return newDurationExpr(s)
}
// DurationExpr contains the duration
type DurationExpr struct {
// s is a string representation of the duration.
//
// it must contain valid duration if needsParsing is set to false.
s string
// needsParsing is set to true if s isn't parsed yet with expandWithExpr()
needsParsing bool
}
func newDurationExpr(s string) (*DurationExpr, error) {
if _, err := DurationValue(s, 0); err != nil {
return nil, fmt.Errorf(`cannot parse duration %q: %w`, s, err)
}
de := &DurationExpr{
s: s,
}
return de, nil
}
// AppendString appends string representation of de to dst and returns the result.
func (de *DurationExpr) AppendString(dst []byte) []byte {
if de == nil {
return dst
}
return append(dst, de.s...)
}
// NonNegativeDuration returns non-negative duration for de in milliseconds.
//
// Error is returned if the duration is negative.
func (de *DurationExpr) NonNegativeDuration(step int64) (int64, error) {
d := de.Duration(step)
if d < 0 {
return 0, fmt.Errorf("unexpected negative duration %dms", d)
}
return d, nil
}
// Duration returns the duration from de in milliseconds.
func (de *DurationExpr) Duration(step int64) int64 {
if de == nil {
return 0
}
if de.needsParsing {
panic(fmt.Errorf("BUG: duration %q must be already parsed", de.s))
}
d, err := DurationValue(de.s, step)
if err != nil {
panic(fmt.Errorf("BUG: cannot parse duration %q: %s", de.s, err))
}
return d
}
// parseIdentExpr parses expressions starting with `ident` token.
func (p *parser) parseIdentExpr() (Expr, error) {
// Look into the next-next token in order to determine how to parse
// the current expression.
if err := p.lex.Next(); err != nil {
return nil, err
}
if isEOF(p.lex.Token) || isOffset(p.lex.Token) {
p.lex.Prev()
return p.parseMetricExpr()
}
if isIdentPrefix(p.lex.Token) {
p.lex.Prev()
if IsAggrFunc(p.lex.Token) {
return p.parseAggrFuncExpr()
}
return p.parseMetricExpr()
}
if isBinaryOp(p.lex.Token) {
p.lex.Prev()
return p.parseMetricExpr()
}
switch p.lex.Token {
case "(":
p.lex.Prev()
if IsAggrFunc(p.lex.Token) {
return p.parseAggrFuncExpr()
}
return p.parseFuncExpr()
case "{", "[", ")", ",", "@":
p.lex.Prev()
return p.parseMetricExpr()
default:
return nil, fmt.Errorf(`identExpr: unexpected token %q; want "(", "{", "[", ")", "," or "@"`, p.lex.Token)
}
}
func (p *parser) parseMetricExpr() (*MetricExpr, error) {
var mf *labelFilterExpr
var me MetricExpr
if isIdentPrefix(p.lex.Token) {
mf = &labelFilterExpr{
Label: "__name__",
Value: &StringExpr{
tokens: []string{strconv.Quote(unescapeIdent(p.lex.Token))},
},
}
if err := p.lex.Next(); err != nil {
return nil, err
}
if p.lex.Token != "{" {
me.labelFilterss = append(me.labelFilterss, []*labelFilterExpr{mf})
return &me, nil
}
}
lfess, err := p.parseLabelFilterss(mf)
if err != nil {
return nil, err
}
me.labelFilterss = append(me.labelFilterss, lfess...)
return &me, nil
}
func (p *parser) parseRollupExpr(arg Expr) (Expr, error) {
var re RollupExpr
re.Expr = arg
if p.lex.Token == "[" {
window, step, inheritStep, err := p.parseWindowAndStep()
if err != nil {
return nil, err
}
re.Window = window
re.Step = step
re.InheritStep = inheritStep
if !isOffset(p.lex.Token) && p.lex.Token != "@" {
return &re, nil
}
}
if p.lex.Token == "@" {
at, err := p.parseAtExpr()
if err != nil {
return nil, err
}
re.At = at
}
if isOffset(p.lex.Token) {
offset, err := p.parseOffset()
if err != nil {
return nil, err
}
re.Offset = offset
}
if p.lex.Token == "@" {
if re.At != nil {
return nil, fmt.Errorf("duplicate `@` token")
}
at, err := p.parseAtExpr()
if err != nil {
return nil, err
}
re.At = at
}
return &re, nil
}
// StringExpr represents string expression.
type StringExpr struct {
// S contains unquoted value for string expression.
S string
// Composite string has non-empty tokens.
// They must be converted into S by expandWithExpr.
tokens []string
}
// AppendString appends string representation of se to dst and returns the result.
func (se *StringExpr) AppendString(dst []byte) []byte {
if len(se.tokens) > 0 {
for i, token := range se.tokens {
dst = append(dst, token...)
if i+1 < len(se.tokens) {
dst = append(dst, '+')
}
}
return dst
}
return strconv.AppendQuote(dst, se.S)
}
// NumberExpr represents number expression.
type NumberExpr struct {
// N is the parsed number, i.e. `1.23`, `-234`, etc.
N float64
// s contains the original string representation for N.
s string
}
// AppendString appends string representation of ne to dst and returns the result.
func (ne *NumberExpr) AppendString(dst []byte) []byte {
if ne.s != "" {
return append(dst, ne.s...)
}
return strconv.AppendFloat(dst, ne.N, 'g', -1, 64)
}
// parensExpr represents `(...)`.
//
// It isn't exported.
type parensExpr []Expr
// AppendString appends string representation of pe to dst and returns the result.
func (pe parensExpr) AppendString(dst []byte) []byte {
return appendStringArgListExpr(dst, pe)
}
// BinaryOpExpr represents binary operation.
type BinaryOpExpr struct {
// Op is the operation itself, i.e. `+`, `-`, `*`, etc.
Op string
// Bool indicates whether `bool` modifier is present.
// For example, `foo >bool bar`.
Bool bool
// GroupModifier contains modifier such as "on" or "ignoring".
GroupModifier ModifierExpr
// JoinModifier contains modifier such as "group_left" or "group_right".
JoinModifier ModifierExpr
// JoinModifierPrefix is an optional prefix to add to labels specified inside group_left() or group_right() lists.
//
// The syntax is `group_left(foo,bar) prefix "abc"`
JoinModifierPrefix *StringExpr
// If KeepMetricNames is set to true, then the operation should keep metric names.
KeepMetricNames bool
// Left contains left arg for the `left op right` expression.
Left Expr
// Right contains right arg for the `left op right` epxression.
Right Expr
}
// AppendString appends string representation of be to dst and returns the result.
func (be *BinaryOpExpr) AppendString(dst []byte) []byte {
if be.KeepMetricNames {
dst = append(dst, '(')
dst = be.appendStringNoKeepMetricNames(dst)
dst = append(dst, ") keep_metric_names"...)
} else {
dst = be.appendStringNoKeepMetricNames(dst)
}
return dst
}
func (be *BinaryOpExpr) appendStringNoKeepMetricNames(dst []byte) []byte {
if be.needLeftParens() {
dst = appendArgInParens(dst, be.Left)
} else {
dst = be.Left.AppendString(dst)
}
dst = append(dst, ' ')
dst = be.appendModifiers(dst)
dst = append(dst, ' ')
if be.needRightParens() {
dst = appendArgInParens(dst, be.Right)
} else {
dst = be.Right.AppendString(dst)
}
return dst
}
func (be *BinaryOpExpr) needLeftParens() bool {
return needBinaryOpArgParens(be.Left)
}
func (be *BinaryOpExpr) needRightParens() bool {
if needBinaryOpArgParens(be.Right) {
return true
}
switch t := be.Right.(type) {
case *MetricExpr:
metricName := t.getMetricName()
return isReservedBinaryOpIdent(metricName)
case *FuncExpr:
if isReservedBinaryOpIdent(t.Name) {
return true
}
return t.KeepMetricNames || be.KeepMetricNames
default:
return false
}
}
func (be *BinaryOpExpr) appendModifiers(dst []byte) []byte {
dst = append(dst, be.Op...)
if be.Bool {
dst = append(dst, "bool"...)
}
if be.GroupModifier.Op != "" {
dst = append(dst, ' ')
dst = be.GroupModifier.AppendString(dst)
}
if be.JoinModifier.Op != "" {
dst = append(dst, ' ')
dst = be.JoinModifier.AppendString(dst)
if prefix := be.JoinModifierPrefix; prefix != nil {
dst = append(dst, " prefix "...)
dst = prefix.AppendString(dst)
}
}
return dst
}
func needBinaryOpArgParens(arg Expr) bool {
switch t := arg.(type) {
case *BinaryOpExpr:
return true
case *RollupExpr:
if be, ok := t.Expr.(*BinaryOpExpr); ok && be.KeepMetricNames {
return true
}
return t.Offset != nil || t.At != nil
default:
return false
}
}
func isReservedBinaryOpIdent(s string) bool {
return isBinaryOpGroupModifier(s) || isBinaryOpJoinModifier(s) || isBinaryOpBoolModifier(s) || isPrefixModifier(s)
}
func isPrefixModifier(s string) bool {
return strings.ToLower(s) == "prefix"
}
func appendArgInParens(dst []byte, arg Expr) []byte {
dst = append(dst, '(')
dst = arg.AppendString(dst)
dst = append(dst, ')')
return dst
}
// ModifierExpr represents MetricsQL modifier such as `<op> (...)`
type ModifierExpr struct {
// Op is modifier operation.
Op string
// Args contains modifier args from parens.
Args []string
}
// AppendString appends string representation of me to dst and returns the result.
func (me *ModifierExpr) AppendString(dst []byte) []byte {
dst = append(dst, me.Op...)
dst = append(dst, '(')
for i, arg := range me.Args {
if arg == "*" {
dst = append(dst, '*')
} else {
dst = appendEscapedIdent(dst, arg)
}
if i+1 < len(me.Args) {
dst = append(dst, ',')
}
}
dst = append(dst, ')')
return dst
}
func appendStringArgListExpr(dst []byte, args []Expr) []byte {
dst = append(dst, '(')
for i, arg := range args {
dst = arg.AppendString(dst)
if i+1 < len(args) {
dst = append(dst, ", "...)
}
}
dst = append(dst, ')')
return dst
}
// FuncExpr represetns MetricsQL function such as `foo(...)`
type FuncExpr struct {
// Name is function name.
Name string
// Args contains function args.
Args []Expr
// If KeepMetricNames is set to true, then the function should keep metric names.
KeepMetricNames bool
}
// AppendString appends string representation of fe to dst and returns the result.
func (fe *FuncExpr) AppendString(dst []byte) []byte {
dst = appendEscapedIdent(dst, fe.Name)
dst = appendStringArgListExpr(dst, fe.Args)
return fe.appendModifiers(dst)
}
func (fe *FuncExpr) appendModifiers(dst []byte) []byte {
if fe.KeepMetricNames {
dst = append(dst, " keep_metric_names"...)
}
return dst
}
// AggrFuncExpr represents aggregate function such as `sum(...) by (...)`
type AggrFuncExpr struct {
// Name is the function name.
Name string
// Args is the function args.
Args []Expr
// Modifier is optional modifier such as `by (...)` or `without (...)`.
Modifier ModifierExpr
// Optional limit for the number of output time series.
// This is MetricsQL extension.
//
// Example: `sum(...) by (...) limit 10` would return maximum 10 time series.
Limit int
}
// AppendString appends string representation of ae to dst and returns the result.
func (ae *AggrFuncExpr) AppendString(dst []byte) []byte {
dst = appendEscapedIdent(dst, ae.Name)
dst = appendStringArgListExpr(dst, ae.Args)
return ae.appendModifiers(dst)
}
func (ae *AggrFuncExpr) appendModifiers(dst []byte) []byte {
if ae.Modifier.Op != "" {
dst = append(dst, ' ')
dst = ae.Modifier.AppendString(dst)
}
if ae.Limit > 0 {
dst = append(dst, " limit "...)
dst = strconv.AppendInt(dst, int64(ae.Limit), 10)
}
return dst
}
// withExpr represents `with (...)` extension from MetricsQL.
//
// It isn't exported.
type withExpr struct {
Was []*withArgExpr
Expr Expr
}
// AppendString appends string representation of we to dst and returns the result.
func (we *withExpr) AppendString(dst []byte) []byte {
dst = append(dst, "WITH ("...)
for i, wa := range we.Was {
dst = wa.AppendString(dst)
if i+1 < len(we.Was) {
dst = append(dst, ", "...)
}
}
dst = append(dst, ") "...)
dst = we.Expr.AppendString(dst)
return dst
}
// withArgExpr represents a single entry from WITH expression.
//
// It isn't exported.
type withArgExpr struct {
Name string
Args []string
Expr Expr
}
// AppendString appends string representation of wa to dst and returns the result.
func (wa *withArgExpr) AppendString(dst []byte) []byte {
dst = appendEscapedIdent(dst, wa.Name)
if len(wa.Args) > 0 {
dst = append(dst, '(')
for i, arg := range wa.Args {
dst = appendEscapedIdent(dst, arg)
if i+1 < len(wa.Args) {
dst = append(dst, ',')
}
}
dst = append(dst, ')')
}
dst = append(dst, " = "...)
dst = wa.Expr.AppendString(dst)
return dst
}
// RollupExpr represents MetricsQL expression, which contains at least `offset` or `[...]` part.
type RollupExpr struct {
// The expression for the rollup. Usually it is MetricExpr, but may be arbitrary expr
// if subquery is used. https://prometheus.io/blog/2019/01/28/subquery-support/
Expr Expr
// Window contains optional window value from square brackets
//
// For example, `http_requests_total[5m]` will have Window value `5m`.
Window *DurationExpr
// Offset contains optional value from `offset` part.
//
// For example, `foobar{baz="aa"} offset 5m` will have Offset value `5m`.
Offset *DurationExpr
// Step contains optional step value from square brackets.
//
// For example, `foobar[1h:3m]` will have Step value '3m'.
Step *DurationExpr
// If set to true, then `foo[1h:]` would print the same
// instead of `foo[1h]`.
InheritStep bool
// At contains an optional expression after `@` modifier.
//
// For example, `foo @ end()` or `bar[5m] @ 12345`
// See https://prometheus.io/docs/prometheus/latest/querying/basics/#modifier
At Expr
}
// ForSubquery returns true if re represents subquery.
func (re *RollupExpr) ForSubquery() bool {
return re.Step != nil || re.InheritStep
}
// AppendString appends string representation of re to dst and returns the result.
func (re *RollupExpr) AppendString(dst []byte) []byte {
needParens := re.needParens()
if needParens {
dst = append(dst, '(')
}
dst = re.Expr.AppendString(dst)
if needParens {
dst = append(dst, ')')
}
return re.appendModifiers(dst)
}
func (re *RollupExpr) appendModifiers(dst []byte) []byte {
if re.Window != nil || re.InheritStep || re.Step != nil {
dst = append(dst, '[')
dst = re.Window.AppendString(dst)
if re.Step != nil {
dst = append(dst, ':')
dst = re.Step.AppendString(dst)
} else if re.InheritStep {
dst = append(dst, ':')
}
dst = append(dst, ']')
}
if re.Offset != nil {
dst = append(dst, " offset "...)
dst = re.Offset.AppendString(dst)
}
if re.At != nil {
dst = append(dst, " @ "...)
_, needAtParens := re.At.(*BinaryOpExpr)
if needAtParens {
dst = append(dst, '(')
}
dst = re.At.AppendString(dst)
if needAtParens {
dst = append(dst, ')')
}
}
return dst
}
func (re *RollupExpr) needParens() bool {
switch t := re.Expr.(type) {
case *RollupExpr, *BinaryOpExpr:
return true
case *AggrFuncExpr:
return t.Modifier.Op != ""
default:
return false
}
}
// LabelFilter represents MetricsQL label filter like `foo="bar"`.
type LabelFilter struct {
// Label contains label name for the filter.
Label string
// Value contains unquoted value for the filter.
Value string
// IsNegative reperesents whether the filter is negative, i.e. '!=' or '!~'.
IsNegative bool
// IsRegexp represents whether the filter is regesp, i.e. `=~` or `!~`.
IsRegexp bool
}
// AppendString appends string representation of me to dst and returns the result.
func (lf *LabelFilter) AppendString(dst []byte) []byte {
dst = appendEscapedIdent(dst, lf.Label)
dst = appendLabelFilterOp(dst, lf.IsNegative, lf.IsRegexp)
dst = strconv.AppendQuote(dst, lf.Value)
return dst
}
func appendLabelFilterOp(dst []byte, isNegative, isRegexp bool) []byte {
if isNegative {
if isRegexp {
return append(dst, "!~"...)
}
return append(dst, "!="...)
}
if isRegexp {
return append(dst, "=~"...)
}
return append(dst, '=')
}
// MetricExpr represents MetricsQL metric with optional filters, i.e. `foo{...}`.
//
// Curly braces may contain or-delimited list of filters. For example:
//
// x{job="foo",instance="bar" or job="x",instance="baz"}
//
// In this case the filter returns all the series, which match at least one of the following filters:
//
// x{job="foo",instance="bar"}
// x{job="x",instance="baz"}
//
// This allows using or-delimited list of filters inside rollup functions. For example,
// the following query calculates rate per each matching series for the given or-delimited filters:
//
// rate(x{job="foo",instance="bar" or job="x",instance="baz"}[5m])
type MetricExpr struct {
// LabelFilters contains a list of or-delimited groups of label filters from curly braces.
// Filter for metric name (aka __name__ label) must go first in every group.
LabelFilterss [][]LabelFilter
// labelFilters contain non-expanded label filters joined by 'or' operator.
//
// labelFilters must be expanded to LabelFilters by expandWithExpr.
labelFilterss [][]*labelFilterExpr
}
func appendLabelFilterss(dst []byte, lfss [][]*labelFilterExpr) []byte {
offset := 0
metricName := getMetricNameFromLabelFilterss(lfss)
metricNameHasEscapedChars := hasEscapedChars(metricName)
if metricName != "" {
offset = 1
if !metricNameHasEscapedChars {
dst = appendEscapedIdent(dst, metricName)
} else {
dst = append(dst, '{')
dst = appendQuotedIdent(dst, metricName)
}
}
if isOnlyMetricNameInLabelFilterss(lfss) {
if metricNameHasEscapedChars {
dst = append(dst, '}')
}
return dst
}
if !metricNameHasEscapedChars {
dst = append(dst, '{')
} else {
dst = append(dst, ',', ' ')
}
for i, lfs := range lfss {
lfs = lfs[offset:]
if len(lfs) == 0 {
continue
}
dst = appendLabelFilterExprs(dst, lfs)
if i+1 < len(lfss) && len(lfss[i+1]) > offset {
dst = append(dst, " or "...)
}
}
dst = append(dst, '}')
return dst
}
func appendLabelFilterExprs(dst []byte, lfs []*labelFilterExpr) []byte {
for i, lf := range lfs {
dst = lf.AppendString(dst)
if i+1 < len(lfs) {
dst = append(dst, ',')
}
}
return dst
}
func isOnlyMetricNameInLabelFilterss(lfss [][]*labelFilterExpr) bool {
if getMetricNameFromLabelFilterss(lfss) == "" {
return false
}
for _, lfs := range lfss {
if len(lfs) > 1 {
return false
}
}
return true
}
func getMetricNameFromLabelFilterss(lfss [][]*labelFilterExpr) string {
if len(lfss) == 0 {
return ""
}
metricName := mustGetMetricName(lfss[0])
if metricName == "" {
return ""
}
for _, lfs := range lfss[1:] {
metricNameLocal := mustGetMetricName(lfs)
if metricNameLocal != metricName {
return ""
}
}
return metricName
}
func mustGetMetricName(lfss []*labelFilterExpr) string {
if len(lfss) == 0 {
return ""
}
lfs := lfss[0]
if lfs.Label != "__name__" || lfs.Value == nil || len(lfs.Value.tokens) != 1 || lfs.IsRegexp || lfs.IsNegative {
if lfs.IsPossibleMetricName {
return lfs.Label
}
return ""
}
metricName, err := extractStringValue(lfs.Value.tokens[0])
if err != nil {
panic(fmt.Errorf("BUG: cannot obtain metric name: %w", err))
}
return metricName
}
// AppendString appends string representation of me to dst and returns the result.
func (me *MetricExpr) AppendString(dst []byte) []byte {
if len(me.labelFilterss) > 0 {
return appendLabelFilterss(dst, me.labelFilterss)
}
lfss := me.LabelFilterss
if len(lfss) == 0 {
dst = append(dst, "{}"...)
return dst
}
offset := 0
metricName := me.getMetricName()
if metricName != "" {
offset = 1
dst = appendEscapedIdent(dst, metricName)
}
if me.isOnlyMetricName() {
return dst
}
dst = append(dst, '{')
for i, lfs := range lfss {
lfs = lfs[offset:]
if len(lfs) == 0 {
continue
}
dst = appendLabelFilters(dst, lfs)
if i+1 < len(lfss) && len(lfss[i+1]) > offset {
dst = append(dst, " or "...)
}
}
dst = append(dst, '}')
return dst
}
func appendLabelFilters(dst []byte, lfs []LabelFilter) []byte {
if len(lfs) == 0 {
return dst
}
dst = lfs[0].AppendString(dst)
lfs = lfs[1:]
for i := range lfs {
dst = append(dst, ',')
dst = lfs[i].AppendString(dst)
}
return dst
}
// IsEmpty returns true of me equals to `{}`.
func (me *MetricExpr) IsEmpty() bool {
return len(me.LabelFilterss) == 0
}
func (me *MetricExpr) isOnlyMetricName() bool {
if me.getMetricName() == "" {
return false
}
for _, lfs := range me.LabelFilterss {
if len(lfs) > 1 {
return false
}
}
return true
}
func (me *MetricExpr) getMetricName() string {
lfss := me.LabelFilterss
if len(lfss) == 0 {
return ""
}
lfs := lfss[0]
if len(lfs) == 0 || !lfs[0].isMetricNameFilter() {
return ""
}
metricName := lfs[0].Value
for _, lfs := range lfss[1:] {
if len(lfs) == 0 || !lfs[0].isMetricNameFilter() || lfs[0].Value != metricName {
return ""
}
}
return metricName
}
func (lf *LabelFilter) isMetricNameFilter() bool {
return lf.Label == "__name__" && !lf.IsNegative && !lf.IsRegexp
}