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

Logs volume: Add options to specify field to group by (#83823)

Browse Source 
Logs volume: Add options to specify field to group by in options
This commit is contained in:
Ivana Huckova
2024-03-06 12:32:28 +01:00
committed by GitHub
parent 5950dc3279
commit 401265522e
3 changed files with 51 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/grafana-data/src/types/logs.ts
View File

@@ -185,6 +185,7 @@ export type SupplementaryQueryOptions = LogsVolumeOption | LogsSampleOptions;
*/
export type LogsVolumeOption = {
type: SupplementaryQueryType.LogsVolume;
field?: string;
};
/**
@@ -237,7 +238,8 @@ export interface DataSourceWithSupplementaryQueriesSupport<TQuery extends DataQu
*/
getSupplementaryRequest?(
type: SupplementaryQueryType,
request: DataQueryRequest<TQuery>
request: DataQueryRequest<TQuery>,
options?: SupplementaryQueryOptions
): DataQueryRequest<TQuery> | undefined;
/**
* Returns supplementary query types that data source supports.

26
public/app/plugins/datasource/loki/datasource.test.ts
View File

@@ -1349,6 +1349,7 @@ describe('LokiDatasource', () => {
queryType: LokiQueryType.Range,
refId: 'log-volume-A',
supportingQueryType: SupportingQueryType.LogsVolume,
legendFormat: '{{ level }}',
});
});
@@ -1367,6 +1368,7 @@ describe('LokiDatasource', () => {
queryType: LokiQueryType.Range,
refId: 'log-volume-A',
supportingQueryType: SupportingQueryType.LogsVolume,
legendFormat: '{{ level }}',
});
});
@@ -1395,6 +1397,30 @@ describe('LokiDatasource', () => {
)
).toEqual(undefined);
});
it('return logs volume query with defined field', () => {
const query = ds.getSupplementaryQuery(
{ type: SupplementaryQueryType.LogsVolume, field: 'test' },
{
expr: '{label="value"}',
queryType: LokiQueryType.Range,
refId: 'A',
}
);
expect(query?.expr).toEqual('sum by (test) (count_over_time({label="value"} | drop __error__[$__auto]))');
});
it('return logs volume query with level as field if no field specified', () => {
const query = ds.getSupplementaryQuery(
{ type: SupplementaryQueryType.LogsVolume },
{
expr: '{label="value"}',
queryType: LokiQueryType.Range,
refId: 'A',
}
);
expect(query?.expr).toEqual('sum by (level) (count_over_time({label="value"} | drop __error__[$__auto]))');
});
});
describe('logs sample', () => {

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

@@ -38,6 +38,8 @@ import {
DataSourceGetTagValuesOptions,
DataSourceGetTagKeysOptions,
DataSourceWithQueryModificationSupport,
LogsVolumeOption,
LogsSampleOptions,
} from '@grafana/data';
import { Duration } from '@grafana/lezer-logql';
import { BackendSrvRequest, config, DataSourceWithBackend, getTemplateSrv, TemplateSrv } from '@grafana/runtime';
@@ -167,13 +169,18 @@ export class LokiDatasource
*/
getSupplementaryRequest(
type: SupplementaryQueryType,
request: DataQueryRequest<LokiQuery>
request: DataQueryRequest<LokiQuery>,
options?: SupplementaryQueryOptions
): DataQueryRequest<LokiQuery> | undefined {
switch (type) {
case SupplementaryQueryType.LogsVolume:
return this.getLogsVolumeDataProvider(request);
const logsVolumeOption: LogsVolumeOption =
options?.type === SupplementaryQueryType.LogsVolume ? options : { type };
return this.getLogsVolumeDataProvider(request, logsVolumeOption);
case SupplementaryQueryType.LogsSample:
return this.getLogsSampleDataProvider(request);
const logsSampleOption: LogsSampleOptions =
options?.type === SupplementaryQueryType.LogsSample ? options : { type };
return this.getLogsSampleDataProvider(request, logsSampleOption);
default:
return undefined;
}
@@ -207,6 +214,7 @@ export class LokiDatasource
}
const dropErrorExpression = `${expr} | drop __error__`;
const field = options.field || 'level';
if (isQueryWithError(this.interpolateString(dropErrorExpression, placeHolderScopedVars)) === false) {
expr = dropErrorExpression;
}
@@ -216,7 +224,8 @@ export class LokiDatasource
refId: `${REF_ID_STARTER_LOG_VOLUME}${normalizedQuery.refId}`,
queryType: LokiQueryType.Range,
supportingQueryType: SupportingQueryType.LogsVolume,
expr: `sum by (level) (count_over_time(${expr}[$__auto]))`,
expr: `sum by (${field}) (count_over_time(${expr}[$__auto]))`,
legendFormat: `{{ ${field} }}`,
};
case SupplementaryQueryType.LogsSample:
@@ -242,10 +251,13 @@ export class LokiDatasource
* Private method used in the `getDataProvider` for DataSourceWithSupplementaryQueriesSupport, specifically for Logs volume queries.
* @returns An Observable of DataQueryResponse or undefined if no suitable queries are found.
*/
private getLogsVolumeDataProvider(request: DataQueryRequest<LokiQuery>): DataQueryRequest<LokiQuery> | undefined {
private getLogsVolumeDataProvider(
request: DataQueryRequest<LokiQuery>,
options: LogsVolumeOption
): DataQueryRequest<LokiQuery> | undefined {
const logsVolumeRequest = cloneDeep(request);
const targets = logsVolumeRequest.targets
.map((query) => this.getSupplementaryQuery({ type: SupplementaryQueryType.LogsVolume }, query))
.map((query) => this.getSupplementaryQuery(options, query))
.filter((query): query is LokiQuery => !!query);
if (!targets.length) {
@@ -259,7 +271,10 @@ export class LokiDatasource
* Private method used in the `getDataProvider` for DataSourceWithSupplementaryQueriesSupport, specifically for Logs sample queries.
* @returns An Observable of DataQueryResponse or undefined if no suitable queries are found.
*/
private getLogsSampleDataProvider(request: DataQueryRequest<LokiQuery>): DataQueryRequest<LokiQuery> | undefined {
private getLogsSampleDataProvider(
request: DataQueryRequest<LokiQuery>,
options?: LogsSampleOptions
): DataQueryRequest<LokiQuery> | undefined {
const logsSampleRequest = cloneDeep(request);
const targets = logsSampleRequest.targets
.map((query) => this.getSupplementaryQuery({ type: SupplementaryQueryType.LogsSample, limit: 100 }, query))