Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mimirtool: use strings replacer in dashboards queries analyzer #8062

Merged
merged 2 commits into from
May 6, 2024
Merged
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 CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
* [BUGFIX] Fix panic in `loadgen` subcommand. #7629
* [ENHANCEMENT] `mimirtool promql format`: Format PromQL query with Prometheus' string or pretty-print formatter. #7742
* [BUGFIX] `mimirtool rules prepare`: do not add aggregation label to `on()` clause if already present in `group_left()` or `group_right()`. #7839
* [BUGFIX] Analyze Grafana: fix parsing queries with variables. #8062

### Mimir Continuous Test

Expand Down
16 changes: 14 additions & 2 deletions pkg/mimirtool/analyze/grafana.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ package analyze
import (
"encoding/json"
"fmt"
"strings"

"github.com/grafana/regexp"
"github.com/pkg/errors"
Expand All @@ -27,6 +28,16 @@ var (
validMetricName = regexp.MustCompile(`^[a-zA-Z_:][a-zA-Z0-9_:]*$`)
variableRangeQueryRangeRegex = regexp.MustCompile(`\[\$?\w+?]`)
variableSubqueryRangeRegex = regexp.MustCompile(`\[\$?\w+:\$?\w+?]`)
variableReplacer = strings.NewReplacer(
"$__interval", "5m",
"$interval", "5m",
"$resolution", "5s",
"$__rate_interval", "15s",
"$rate_interval", "15s",
"$__range", "1d",
"${__range_s:glob}", "30",
"${__range_s}", "30",
)
)

type MetricsInGrafana struct {
Expand Down Expand Up @@ -205,14 +216,15 @@ func metricsFromPanel(panel minisdk.Panel, metrics map[string]struct{}) []error
return parseErrors
}

func removeVariablesFromRanges(query string) string {
func replaceVariables(query string) string {
query = variableReplacer.Replace(query)
query = variableRangeQueryRangeRegex.ReplaceAllLiteralString(query, `[5m]`)
query = variableSubqueryRangeRegex.ReplaceAllLiteralString(query, `[5m:1m]`)
return query
}

func parseQuery(query string, metrics map[string]struct{}) error {
expr, err := parser.ParseExpr(removeVariablesFromRanges(query))
expr, err := parser.ParseExpr(replaceVariables(query))
if err != nil {
return err
}
Expand Down
59 changes: 58 additions & 1 deletion pkg/mimirtool/analyze/grafana_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ func TestMetricsFromTemplating(t *testing.T) {
require.Empty(t, metrics)
})

t.Run(`label_values query with no metric selector multiline `, func(t *testing.T) {
t.Run(`label_values query with no metric selector multiline`, func(t *testing.T) {
metrics := make(map[string]struct{})
in := minisdk.Templating{
List: []minisdk.TemplateVar{
Expand All @@ -166,4 +166,61 @@ func TestMetricsFromTemplating(t *testing.T) {
require.Empty(t, errs)
require.Empty(t, metrics)
})

t.Run(`query contains a subquery with the $__interval variable`, func(t *testing.T) {
metrics := make(map[string]struct{})
in := minisdk.Templating{
List: []minisdk.TemplateVar{
{
Name: "variable",
Type: "query",
Datasource: nil,
Query: `increase(varnish_main_threads_failed{job=~"$job",instance=~"$instance"}[$__interval:])`,
},
},
}

errs := metricsFromTemplating(in, metrics)
require.Empty(t, errs)
require.Len(t, metrics, 1)
require.Equal(t, map[string]struct{}{"varnish_main_threads_failed": {}}, metrics)
})

t.Run(`query uses offset with $__interval variable`, func(t *testing.T) {
metrics := make(map[string]struct{})
in := minisdk.Templating{
List: []minisdk.TemplateVar{
{
Name: "variable",
Type: "query",
Datasource: nil,
Query: `increase(tomcat_session_processingtime_total{job=~"$job", instance=~"$instance", host=~"$host", context=~"$context"}[$__interval:] offset -$__interval)`,
},
},
}

errs := metricsFromTemplating(in, metrics)
require.Empty(t, errs)
require.Len(t, metrics, 1)
require.Equal(t, map[string]struct{}{"tomcat_session_processingtime_total": {}}, metrics)
})

t.Run(`query contains range with other variables`, func(t *testing.T) {
metrics := make(map[string]struct{})
in := minisdk.Templating{
List: []minisdk.TemplateVar{
{
Name: "variable",
Type: "query",
Datasource: nil,
Query: `myapp_metric_foo[$__from:$__to]`,
},
},
}

errs := metricsFromTemplating(in, metrics)
require.Empty(t, errs)
require.Len(t, metrics, 1)
require.Equal(t, map[string]struct{}{"myapp_metric_foo": {}}, metrics)
})
}
Loading