Skip to content

N
nexpie-grafana-theme
Commit 54a3f5fd by David Committed by GitHub
Options

Loki: use series API for stream facetting (#21332)

parent 2cf538a4
Showing with 102 additions and 43 deletions
public/app/plugins/datasource/loki/components/__snapshots__/LokiExploreQueryEditor.test.tsx.snap
...@@ -56,11 +56,43 @@ exports[`LokiExploreQueryEditor should render component 1`] = ` ...@@ -56,11 +56,43 @@ exports[`LokiExploreQueryEditor should render component 1`] = `
"languageProvider": LokiLanguageProvider { "languageProvider": LokiLanguageProvider {
"cleanText": [Function], "cleanText": [Function],
"datasource": [Circular], "datasource": [Circular],
"fetchSeriesLabels": [Function],
"getBeginningCompletionItems": [Function], "getBeginningCompletionItems": [Function],
"getTermCompletionItems": [Function], "getTermCompletionItems": [Function],
"labelKeys": Object {}, "labelKeys": Array [],
"labelValues": Object {}, "labelsCache": LRUCache {
Symbol(max): 10,
Symbol(lengthCalculator): [Function],
Symbol(allowStale): false,
Symbol(maxAge): 0,
Symbol(dispose): undefined,
Symbol(noDisposeOnSet): false,
Symbol(updateAgeOnGet): false,
Symbol(cache): Map {},
Symbol(lruList): Yallist {
"head": null,
"length": 0,
"tail": null,
},
Symbol(length): 0,
},
"request": [Function], "request": [Function],
"seriesCache": LRUCache {
Symbol(max): 10,
Symbol(lengthCalculator): [Function],
Symbol(allowStale): false,
Symbol(maxAge): 0,
Symbol(dispose): undefined,
Symbol(noDisposeOnSet): false,
Symbol(updateAgeOnGet): false,
Symbol(cache): Map {},
Symbol(lruList): Yallist {
"head": null,
"length": 0,
"tail": null,
},
Symbol(length): 0,
},
"start": [Function], "start": [Function],
}, },
"metadataRequest": [Function], "metadataRequest": [Function],
......
public/app/plugins/datasource/loki/components/useLokiSyntaxAndLabels.test.ts
...@@ -59,9 +59,9 @@ describe('useLokiSyntax hook', () => { ...@@ -59,9 +59,9 @@ describe('useLokiSyntax hook', () => {
await waitForNextUpdate(); await waitForNextUpdate();
expect(result.current.logLabelOptions).toEqual(logLabelOptionsMock2); expect(result.current.logLabelOptions).toEqual(logLabelOptionsMock2);
languageProvider.fetchLabelValues = (key: string) => { languageProvider.fetchLabelValues = (key: string, absoluteRange: AbsoluteTimeRange) => {
languageProvider.logLabelOptions = logLabelOptionsMock3; languageProvider.logLabelOptions = logLabelOptionsMock3;
return Promise.resolve(); return Promise.resolve([]);
}; };
act(() => result.current.setActiveOption([activeOptionMock])); act(() => result.current.setActiveOption([activeOptionMock]));
......
public/app/plugins/datasource/loki/datasource.ts
...@@ -390,9 +390,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> { ...@@ -390,9 +390,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> {
async metadataRequest(url: string, params?: Record<string, string>) { async metadataRequest(url: string, params?: Record<string, string>) {
const res = await this._request(url, params, { silent: true }).toPromise(); const res = await this._request(url, params, { silent: true }).toPromise();
return { return res.data.data || res.data.values || [];
data: { data: res.data.data || res.data.values || [] },
};
} }
async metricFindQuery(query: string) { async metricFindQuery(query: string) {
...@@ -423,7 +421,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> { ...@@ -423,7 +421,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> {
async labelNamesQuery() { async labelNamesQuery() {
const url = (await this.getVersion()) === 'v0' ? `${LEGACY_LOKI_ENDPOINT}/label` : `${LOKI_ENDPOINT}/label`; const url = (await this.getVersion()) === 'v0' ? `${LEGACY_LOKI_ENDPOINT}/label` : `${LOKI_ENDPOINT}/label`;
const result = await this.metadataRequest(url); const result = await this.metadataRequest(url);
return result.data.data.map((value: string) => ({ text: value })); return result.map((value: string) => ({ text: value }));
} }
async labelValuesQuery(label: string) { async labelValuesQuery(label: string) {
...@@ -432,7 +430,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> { ...@@ -432,7 +430,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> {
? `${LEGACY_LOKI_ENDPOINT}/label/${label}/values` ? `${LEGACY_LOKI_ENDPOINT}/label/${label}/values`
: `${LOKI_ENDPOINT}/label/${label}/values`; : `${LOKI_ENDPOINT}/label/${label}/values`;
const result = await this.metadataRequest(url); const result = await this.metadataRequest(url);
return result.data.data.map((value: string) => ({ text: value })); return result.map((value: string) => ({ text: value }));
} }
interpolateQueryExpr(value: any, variable: any) { interpolateQueryExpr(value: any, variable: any) {
......
public/app/plugins/datasource/loki/language_provider.test.ts
import Plain from 'slate-plain-serializer'; import Plain from 'slate-plain-serializer';
import { Editor as SlateEditor } from 'slate';
import LanguageProvider, { LABEL_REFRESH_INTERVAL, LokiHistoryItem, rangeToParams } from './language_provider'; import LanguageProvider, { LABEL_REFRESH_INTERVAL, LokiHistoryItem, rangeToParams } from './language_provider';
import { AbsoluteTimeRange } from '@grafana/data'; import { AbsoluteTimeRange } from '@grafana/data';
...@@ -85,34 +84,53 @@ describe('Language completion provider', () => { ...@@ -85,34 +84,53 @@ describe('Language completion provider', () => {
}); });
}); });
describe('label suggestions', () => { describe('label key suggestions', () => {
it('returns default label suggestions on label context', async () => { it('returns all label suggestions on empty selector', async () => {
const instance = new LanguageProvider(datasource); const datasource = makeMockLokiDatasource({ label1: [], label2: [] });
const value = Plain.deserialize('{}'); const provider = await getLanguageProvider(datasource);
const ed = new SlateEditor({ value }); const input = createTypeaheadInput('{}', '', '', 1);
const valueWithSelection = ed.moveForward(1).value; const result = await provider.provideCompletionItems(input, { absoluteRange: rangeMock });
const result = await instance.provideCompletionItems(
{
text: '',
prefix: '',
wrapperClasses: ['context-labels'],
value: valueWithSelection,
},
{ absoluteRange: rangeMock }
);
expect(result.context).toBe('context-labels'); expect(result.context).toBe('context-labels');
expect(result.suggestions).toEqual([{ items: [{ label: 'job' }, { label: 'namespace' }], label: 'Labels' }]); expect(result.suggestions).toEqual([{ items: [{ label: 'label1' }, { label: 'label2' }], label: 'Labels' }]);
}); });
it('returns label suggestions from Loki', async () => { it('returns all label suggestions on selector when starting to type', async () => {
const datasource = makeMockLokiDatasource({ label1: [], label2: [] }); const datasource = makeMockLokiDatasource({ label1: [], label2: [] });
const provider = await getLanguageProvider(datasource); const provider = await getLanguageProvider(datasource);
const input = createTypeaheadInput('{}', ''); const input = createTypeaheadInput('{l}', '', '', 2);
const result = await provider.provideCompletionItems(input, { absoluteRange: rangeMock }); const result = await provider.provideCompletionItems(input, { absoluteRange: rangeMock });
expect(result.context).toBe('context-labels'); expect(result.context).toBe('context-labels');
expect(result.suggestions).toEqual([{ items: [{ label: 'label1' }, { label: 'label2' }], label: 'Labels' }]); expect(result.suggestions).toEqual([{ items: [{ label: 'label1' }, { label: 'label2' }], label: 'Labels' }]);
}); });
});
describe('label suggestions facetted', () => {
it('returns facetted label suggestions based on selector', async () => {
const datasource = makeMockLokiDatasource(
{ label1: [], label2: [] },
{ '{foo="bar"}': [{ label1: 'label_val1' }] }
);
const provider = await getLanguageProvider(datasource);
const input = createTypeaheadInput('{foo="bar",}', '', '', 11);
const result = await provider.provideCompletionItems(input, { absoluteRange: rangeMock });
expect(result.context).toBe('context-labels');
expect(result.suggestions).toEqual([{ items: [{ label: 'label1' }], label: 'Labels' }]);
});
it('returns facetted label suggestions for multipule selectors', async () => {
const datasource = makeMockLokiDatasource(
{ label1: [], label2: [] },
{ '{baz="42",foo="bar"}': [{ label2: 'label_val2' }] }
);
const provider = await getLanguageProvider(datasource);
const input = createTypeaheadInput('{baz="42",foo="bar",}', '', '', 20);
const result = await provider.provideCompletionItems(input, { absoluteRange: rangeMock });
expect(result.context).toBe('context-labels');
expect(result.suggestions).toEqual([{ items: [{ label: 'label2' }], label: 'Labels' }]);
});
});
describe('label suggestions', () => {
it('returns label values suggestions from Loki', async () => { it('returns label values suggestions from Loki', async () => {
const datasource = makeMockLokiDatasource({ label1: ['label1_val1', 'label1_val2'], label2: [] }); const datasource = makeMockLokiDatasource({ label1: ['label1_val1', 'label1_val2'], label2: [] });
const provider = await getLanguageProvider(datasource); const provider = await getLanguageProvider(datasource);
......
public/app/plugins/datasource/loki/mocks.ts
...@@ -3,34 +3,45 @@ import { DataSourceSettings } from '@grafana/data'; ...@@ -3,34 +3,45 @@ import { DataSourceSettings } from '@grafana/data';
import { LokiOptions } from './types'; import { LokiOptions } from './types';
import { createDatasourceSettings } from '../../../features/datasources/mocks'; import { createDatasourceSettings } from '../../../features/datasources/mocks';
export function makeMockLokiDatasource(labelsAndValues: { [label: string]: string[] }): LokiDatasource { interface Labels {
[label: string]: string[];
}
interface Series {
[label: string]: string;
}
interface SeriesForSelector {
[selector: string]: Series[];
}
export function makeMockLokiDatasource(labelsAndValues: Labels, series?: SeriesForSelector): LokiDatasource {
const legacyLokiLabelsAndValuesEndpointRegex = /^\/api\/prom\/label\/(\w*)\/values/; const legacyLokiLabelsAndValuesEndpointRegex = /^\/api\/prom\/label\/(\w*)\/values/;
const lokiLabelsAndValuesEndpointRegex = /^\/loki\/api\/v1\/label\/(\w*)\/values/; const lokiLabelsAndValuesEndpointRegex = /^\/loki\/api\/v1\/label\/(\w*)\/values/;
const lokiSeriesEndpointRegex = /^\/loki\/api\/v1\/series/;
const legacyLokiLabelsEndpoint = `${LEGACY_LOKI_ENDPOINT}/label`; const legacyLokiLabelsEndpoint = `${LEGACY_LOKI_ENDPOINT}/label`;
const lokiLabelsEndpoint = `${LOKI_ENDPOINT}/label`; const lokiLabelsEndpoint = `${LOKI_ENDPOINT}/label`;
const labels = Object.keys(labelsAndValues); const labels = Object.keys(labelsAndValues);
return { return {
metadataRequest: (url: string) => { metadataRequest: (url: string, params?: { [key: string]: string }) => {
let responseData;
if (url === legacyLokiLabelsEndpoint || url === lokiLabelsEndpoint) { if (url === legacyLokiLabelsEndpoint || url === lokiLabelsEndpoint) {
responseData = labels; return labels;
} else { } else {
const match = url.match(legacyLokiLabelsAndValuesEndpointRegex) || url.match(lokiLabelsAndValuesEndpointRegex); const legacyLabelsMatch = url.match(legacyLokiLabelsAndValuesEndpointRegex);
if (match) { const labelsMatch = url.match(lokiLabelsAndValuesEndpointRegex);
responseData = labelsAndValues[match[1]]; const seriesMatch = url.match(lokiSeriesEndpointRegex);
} if (legacyLabelsMatch) {
} return labelsAndValues[legacyLabelsMatch[1]] || [];
if (responseData) { } else if (labelsMatch) {
return { return labelsAndValues[labelsMatch[1]] || [];
data: { } else if (seriesMatch) {
data: responseData, return series[params.match] || [];
},
};
} else { } else {
throw new Error(`Unexpected url error, ${url}`); throw new Error(`Unexpected url error, ${url}`);
} }
}
}, },
} as any; } as any;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment