IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Prometheus: Grafana global variables in PromQL should not raise errors (#60461)

Browse Source
This commit is contained in:
Ludovic Viaud 2023-01-11 13:12:03 +01:00 committed by GitHub
parent 909ec67c56
commit 67cad49570
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
public/app/plugins/datasource/prometheus/querybuilder/parsing.test.ts
View File

@ -54,17 +54,7 @@ describe('buildVisualQueryFromString', () => {
'avg(rate(access_evaluation_duration_count{instance="host.docker.internal:3000"}[$__rate_interval]))'
)
).toEqual({
// after upgrading @prometheus-io/lezer-promql, strings containing global grafana variables such as $__rate_interval (https://grafana.com/docs/grafana/latest/variables/variable-types/global-variables/)
// started returning error nodes upon parse, but the resultant tree was otherwise the same.
// My assumption is that the newer version of lezer is more verbose in returning error nodes, and there should be no functional change to the parsed trees.
errors: [
{
from: 107,
parentType: 'MatrixSelector',
text: '',
to: 107,
},
],
errors: [],
query: {
metric: 'access_evaluation_duration_count',
labels: [
@ -172,14 +162,7 @@ describe('buildVisualQueryFromString', () => {
expect(
buildVisualQueryFromString('histogram_quantile(0.99, rate(counters_logins{app="backend"}[$__rate_interval]))')
).toEqual({
errors: [
{
from: 88,
parentType: 'MatrixSelector',
text: '',
to: 88,
},
],
errors: [],
query: {
metric: 'counters_logins',
labels: [{ label: 'app', op: '=', value: 'backend' }],
@ -203,14 +186,7 @@ describe('buildVisualQueryFromString', () => {
'label_replace(avg_over_time(http_requests_total{instance="foo"}[$__interval]), "instance", "$1", "", "(.*)")'
)
).toEqual({
errors: [
{
from: 86,
parentType: 'MatrixSelector',
text: '',
to: 86,
},
],
errors: [],
query: {
metric: 'http_requests_total',
labels: [{ label: 'instance', op: '=', value: 'foo' }],
@ -230,14 +206,7 @@ describe('buildVisualQueryFromString', () => {
it('parses binary operation with scalar', () => {
expect(buildVisualQueryFromString('avg_over_time(http_requests_total{instance="foo"}[$__interval]) / 2')).toEqual({
errors: [
{
from: 72,
parentType: 'MatrixSelector',
text: '',
to: 72,
},
],
errors: [],
query: {
metric: 'http_requests_total',
labels: [{ label: 'instance', op: '=', value: 'foo' }],
@ -259,14 +228,7 @@ describe('buildVisualQueryFromString', () => {
expect(
buildVisualQueryFromString('avg_over_time(http_requests_total{instance="foo"}[$__interval]) / sum(logins_count)')
).toEqual({
errors: [
{
from: 72,
parentType: 'MatrixSelector',
text: '',
to: 72,
},
],
errors: [],
query: {
metric: 'http_requests_total',
labels: [{ label: 'instance', op: '=', value: 'foo' }],

35
public/app/plugins/datasource/prometheus/querybuilder/parsing.ts
View File

@ -80,6 +80,12 @@ export function buildVisualQueryFromString(expr: string): Context {
if (isEmptyQuery(context.query)) {
context.errors = [];
}
// We don't want parsing errors related to Grafana global variables
if (isValidPromQLMinusGrafanaGlobalVariables(expr)) {
context.errors = [];
}
return context;
}
@ -95,6 +101,35 @@ interface Context {
errors: ParsingError[];
}
function isValidPromQLMinusGrafanaGlobalVariables(expr: string) {
const context: Context = {
query: {
metric: '',
labels: [],
operations: [],
},
errors: [],
};
expr = expr.replace(/\$__interval/g, '1s');
expr = expr.replace(/\$__interval_ms/g, '1000');
expr = expr.replace(/\$__rate_interval/g, '1s');
expr = expr.replace(/\$__range_ms/g, '1000');
expr = expr.replace(/\$__range_s/g, '1');
expr = expr.replace(/\$__range/g, '1s');
const tree = parser.parse(expr);
const node = tree.topNode;
try {
handleExpression(expr, node, context);
} catch (err) {
return false;
}
return context.errors.length === 0;
}
/**
* Handler for default state. It will traverse the tree and call the appropriate handler for each node. The node
* handled here does not necessarily need to be of type == Expr.