Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/validator/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ type validatorCreator func(params yaml.Node) (Validator, error)
var registeredUniversalRuleValidators = map[string]validatorCreator{
// Labels
"hasLabels": newHasLabels,
"hasLabelsForEveryAggregation": newHasLabelsForEveryAggregation,
"doesNotHaveLabels": newDoesNotHaveLabels,
"hasAnyOfLabels": newHasAnyOfLabels,
"labelMatchesRegexp": newLabelMatchesRegexp,
Expand Down
53 changes: 52 additions & 1 deletion pkg/validator/labels.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
"github.com/fusakla/promruval/v3/pkg/unmarshaler"
"github.com/prometheus/prometheus/model/rulefmt"
)

func newHasLabels(paramsConfig yaml.Node) (Validator, error) {
params := struct {
Labels []string `yaml:"labels"`
Expand Down Expand Up @@ -66,6 +65,58 @@ func (h hasLabels) Validate(_ unmarshaler.RuleGroup, rule rulefmt.Rule, _ *prome
return errs
}

func newHasLabelsForEveryAggregation(paramsConfig yaml.Node) (Validator, error) {
params := struct {
Labels []string `yaml:"labels"`
ExcludeRuleLabels bool `yaml:"exclude_rule_labels"`
}{}
if err := paramsConfig.Decode(&params); err != nil {
return nil, err
}
if len(params.Labels) == 0 {
return nil, fmt.Errorf("missing labels")
}
return &hasLabelsForEveryAggregation{labels: params.Labels, excludeRuleLabels: params.ExcludeRuleLabels}, nil
}

type hasLabelsForEveryAggregation struct {
labels []string
excludeRuleLabels bool
}

func (h hasLabelsForEveryAggregation) String() string {
return fmt.Sprintf("every aggregation has labels: `%s`", strings.Join(h.labels, "`,`"))
}

func (h hasLabelsForEveryAggregation) Validate(_ unmarshaler.RuleGroup, rule rulefmt.Rule, _ *prometheus.Client) []error {
var (
errs []error
err error
exprLabels map[string]struct{}
)

exprLabels, err = getExpressionUsedLabelsForEveryAggregation(rule.Expr)
if err != nil {
errs = append(errs, err)
}
if exprLabels == nil {
return errs
}

if h.excludeRuleLabels {
for label, _ := range rule.Labels {
exprLabels[label] = struct{}{}
}
}

for _, label := range h.labels {
if _, ok := exprLabels[label]; !ok {
errs = append(errs, fmt.Errorf("missing label `%s`", label))
}
}
return errs
}

func newDoesNotHaveLabels(paramsConfig yaml.Node) (Validator, error) {
params := struct {
Labels []string `yaml:"labels"`
Expand Down
41 changes: 41 additions & 0 deletions pkg/validator/promql_expression_helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,47 @@ func getExpressionUsedLabels(expr string) ([]string, error) {
return getExpressionUsedLabelsForMetric(expr, regexp.MustCompile(".*"))
}

func getExpressionUsedLabelsForEveryAggregation(expr string) (map[string]struct{}, error) {
promQl, err := parser.ParseExpr(expr)
if err != nil {
return map[string]struct{}{}, fmt.Errorf("failed to parse expression `%s`: %w", expr, err)
}
var usedLabels map[string]struct{}

labelsUpInExpr := func(path []parser.Node) map[string]struct{} {
for _, n := range path {
switch v := n.(type) {
case *parser.AggregateExpr:
usedLabels := map[string]struct{}{}
for _, l := range v.Grouping {
usedLabels[l] = struct{}{}
}
return usedLabels
}
}

return nil
}

parser.Inspect(promQl, func(n parser.Node, path []parser.Node) error {
usedLabelsInExpr := labelsUpInExpr(path)
if usedLabels == nil {
usedLabels = usedLabelsInExpr
}
if usedLabelsInExpr != nil {
for k := range usedLabels {
if _, exists := usedLabelsInExpr[k]; !exists {
delete(usedLabels, k)
}
}

}
return nil
})

return usedLabels, nil
}

func getExpressionVectorSelectors(expr string) ([]*parser.VectorSelector, error) {
promQl, err := parser.ParseExpr(expr)
if err != nil {
Expand Down