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

Legend: extract common renderLegendFormat function (loki+prom) (#43054)

Browse Source
This commit is contained in:
Ryan McKinley 2021-12-14 19:19:16 -08:00 committed by GitHub
parent c2392598ea
commit 00e06874e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 48 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
public/app/plugins/datasource/loki/datasource.ts
View File

@ -62,6 +62,7 @@ import syntax from './syntax';
import { DEFAULT_RESOLUTION } from './components/LokiOptionFields';
import { queryLogsVolume } from 'app/core/logs_model';
import config from 'app/core/config';
import { renderLegendFormat } from '../prometheus/legend';
export type RangeQueryOptions = DataQueryRequest<LokiQuery> | AnnotationQueryRequest<LokiQuery>;
export const DEFAULT_MAX_LINES = 1000;
@ -684,8 +685,8 @@ export class LokiDatasource
view.forEach((row) => {
annotations.push({
time: new Date(row.ts).valueOf(),
title: renderTemplate(titleFormat, labels),
text: renderTemplate(textFormat, labels) || row.line,
title: renderLegendFormat(titleFormat, labels),
text: renderLegendFormat(textFormat, labels) || row.line,
tags,
});
});
@ -752,16 +753,6 @@ export class LokiDatasource
}
}
export function renderTemplate(aliasPattern: string, aliasData: { [key: string]: string }) {
const aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
return aliasPattern.replace(aliasRegex, (_match, g1) => {
if (aliasData[g1]) {
return aliasData[g1];
}
return '';
});
}
export function lokiRegularEscape(value: any) {
if (typeof value === 'string') {
return value.replace(/'/g, "\\\\'");

8
public/app/plugins/datasource/loki/result_transformer.ts
View File

@ -37,6 +37,7 @@ import {
LokiStreamResponse,
LokiStats,
} from './types';
import { renderLegendFormat } from '../prometheus/legend';
const UUID_NAMESPACE = '6ec946da-0f49-47a8-983a-1d76d17e7c92';
@ -282,7 +283,7 @@ export function createMetricLabel(labelData: { [key: string]: string }, options?
let label =
options === undefined || isEmpty(options.legendFormat)
? getOriginalMetricName(labelData)
: renderTemplate(getTemplateSrv().replace(options.legendFormat ?? '', options.scopedVars), labelData);
: renderLegendFormat(getTemplateSrv().replace(options.legendFormat ?? '', options.scopedVars), labelData);
if (!label && options) {
label = options.query;
@ -290,11 +291,6 @@ export function createMetricLabel(labelData: { [key: string]: string }, options?
return label;
}
function renderTemplate(aliasPattern: string, aliasData: { [key: string]: string }) {
const aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
return aliasPattern.replace(aliasRegex, (_, g1) => (aliasData[g1] ? aliasData[g1] : g1));
}
function getOriginalMetricName(labelData: { [key: string]: string }) {
const metricName = labelData.__name__ || '';
delete labelData.__name__;

7
public/app/plugins/datasource/prometheus/datasource.ts
View File

@ -38,7 +38,7 @@ import addLabelToQuery from './add_label_to_query';
import PrometheusLanguageProvider from './language_provider';
import { expandRecordingRules } from './language_utils';
import { getInitHints, getQueryHints } from './query_hints';
import { getOriginalMetricName, renderTemplate, transform, transformV2 } from './result_transformer';
import { getOriginalMetricName, transform, transformV2 } from './result_transformer';
import {
ExemplarTraceIdDestination,
PromDataErrorResponse,
@ -54,6 +54,7 @@ import {
} from './types';
import { PrometheusVariableSupport } from './variables';
import PrometheusMetricFindQuery from './metric_find_query';
import { renderLegendFormat } from './legend';
export const ANNOTATION_QUERY_STEP_DEFAULT = '60s';
const GET_AND_POST_METADATA_ENDPOINTS = ['api/v1/query', 'api/v1/query_range', 'api/v1/series', 'api/v1/labels'];
@ -765,9 +766,9 @@ export class PrometheusDatasource
time: timestamp,
timeEnd: timestamp,
annotation,
title: renderTemplate(titleFormat, labels),
title: renderLegendFormat(titleFormat, labels),
tags,
text: renderTemplate(textFormat, labels),
text: renderLegendFormat(textFormat, labels),
};
}

30
public/app/plugins/datasource/prometheus/legend.test.ts Normal file
View File

@ -0,0 +1,30 @@
import { renderLegendFormat } from './legend';
describe('renderLegendFormat()', () => {
const labels = {
a: 'AAA',
b: 'BBB',
'with space': 'CCC',
};
it('works without any labels', () => {
expect(renderLegendFormat('hello', {})).toEqual('hello');
expect(renderLegendFormat('hello', labels)).toEqual('hello');
});
it('Simple replace', () => {
expect(renderLegendFormat('value: {{a}}', labels)).toEqual('value: AAA');
expect(renderLegendFormat('{{a}} {{with space}}', labels)).toEqual('AAA CCC');
// not sure if this is expected... but current behavior
expect(renderLegendFormat('{{ a }}', labels)).toEqual('AAA');
});
it('Bad syntax', () => {
expect(renderLegendFormat('value: {{a}', labels)).toEqual('value: {{a}');
expect(renderLegendFormat('value: {a}}}', labels)).toEqual('value: {a}}}');
// Current behavior -- not sure if expected or not
expect(renderLegendFormat('value: {{{a}}}', labels)).toEqual('value: {a}');
});
});

7
public/app/plugins/datasource/prometheus/legend.ts Normal file
View File

@ -0,0 +1,7 @@
import { Labels } from '@grafana/data';
/** replace labels in a string. Used for loki+prometheus legend formats */
export function renderLegendFormat(aliasPattern: string, aliasData: Labels): string {
const aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
return aliasPattern.replace(aliasRegex, (_, g1) => (aliasData[g1] ? aliasData[g1] : g1));
}

13
public/app/plugins/datasource/prometheus/result_transformer.ts
View File

@ -33,6 +33,7 @@ import {
PromValue,
TransformOptions,
} from './types';
import { renderLegendFormat } from './legend';
const POSITIVE_INFINITY_SAMPLE_VALUE = '+Inf';
const NEGATIVE_INFINITY_SAMPLE_VALUE = '-Inf';
@ -504,7 +505,7 @@ function getValueField({
function createLabelInfo(labels: { [key: string]: string }, options: TransformOptions) {
if (options?.legendFormat) {
const title = renderTemplate(getTemplateSrv().replace(options.legendFormat, options?.scopedVars), labels);
const title = renderLegendFormat(getTemplateSrv().replace(options.legendFormat, options?.scopedVars), labels);
return { name: title, labels };
}
@ -528,16 +529,6 @@ export function getOriginalMetricName(labelData: { [key: string]: string }) {
return `${metricName}{${labelPart}}`;
}
export function renderTemplate(aliasPattern: string, aliasData: { [key: string]: string }) {
const aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
return aliasPattern.replace(aliasRegex, (_match, g1) => {
if (aliasData[g1]) {
return aliasData[g1];
}
return '';
});
}
function transformToHistogramOverTime(seriesList: DataFrame[]) {
/* t1 = timestamp1, t2 = timestamp2 etc.
t1 t2 t3 t1 t2 t3