Skip to content

Don't send index metadata, revamp Elastic querybuilder #64

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

Merged
merged 4 commits into from
Feb 15, 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
121 changes: 52 additions & 69 deletions src/QueryBuilder/elastic.ts
Original file line number Diff line number Diff line change
@@ -1,84 +1,67 @@
import {
BucketAggregation,
ElasticsearchQuery,
MetricAggregation,
TermsQuery,
} from '../types';

export class ElasticQueryBuilder {
timeField: string;

constructor(options: { timeField: string }) {
this.timeField = options.timeField;
}

getRangeFilter() {
const filter: any = {};
filter[this.timeField] = {
gte: '$timeFrom',
lte: '$timeTo',
// FIXME when Quickwit supports format.
// format: 'epoch_millis',
};

return filter;
}

getTermsQuery(queryDef: TermsQuery) {
const query: any = {
size: 0,
query: {
bool: {
filter: [{ range: this.getRangeFilter() }],
},
},
};

if (queryDef.query) {
query.query.bool.filter.push({
query_string: {
// FIXME when Quickwit supports analyze_wildcard.
// analyze_wildcard: true,
query: queryDef.query,
},
});
}
type OrderByType = '_key' | '_term' | '_count'

let size = 500;
if (queryDef.size) {
size = queryDef.size;
function getTermsAgg(
fieldName: string,
size: number,
orderBy: OrderByType = "_key",
order: 'asc'|'desc' = 'asc'
): BucketAggregation {
return {
type: 'terms',
id: "",
field: fieldName,
settings:{
size: size.toString(),
order: order,
orderBy: orderBy,
}
}
}

query.aggs = {
'1': {
terms: {
field: queryDef.field,
size: size,
order: {},
},
},
};
export function getDataQuery(queryDef: TermsQuery, refId: string): ElasticsearchQuery {
const metrics: MetricAggregation[] = [
{id:"count1", type:'count'}
];

// Default behaviour is to order results by { _key: asc }
// queryDef.order allows selection of asc/desc
// queryDef.orderBy allows selection of doc_count ordering (defaults desc)
// Default behaviour is to order results by { _key: asc }
// queryDef.order allows selection of asc/desc
// queryDef.orderBy allows selection of doc_count ordering (defaults desc)

const { orderBy = 'key', order = orderBy === 'doc_count' ? 'desc' : 'asc' } = queryDef;
let orderBy: OrderByType;
switch (queryDef.orderBy || 'key') {
case 'key':
case 'term':
orderBy = '_key'
break;
case 'doc_count':
orderBy = '_count'
break;
default:
throw { message: `Invalid query sort type ${queryDef.orderBy}` };
}

if (['asc', 'desc'].indexOf(order) < 0) {
throw { message: `Invalid query sort order ${order}` };
}
const {order = orderBy === '_count' ? 'desc' : 'asc' } = queryDef;
if (['asc', 'desc'].indexOf(order) < 0) {
throw { message: `Invalid query sort order ${order}` };
}

switch (orderBy) {
case 'key':
case 'term':
const keyname = '_key';
query.aggs['1'].terms.order[keyname] = order;
break;
case 'doc_count':
query.aggs['1'].terms.order['_count'] = order;
break;
default:
throw { message: `Invalid query sort type ${orderBy}` };
}
const bucketAggs: BucketAggregation[] = [];
if (queryDef.field) {
bucketAggs.push(getTermsAgg(queryDef.field, 500, orderBy, order))
}

return query;
return {
refId,
metrics,
bucketAggs,
query: queryDef.query,
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
} from './actions';

export const createReducer =
(defaultTimeField: string) =>
(defaultTimeField = "") =>
(state: ElasticsearchQuery['bucketAggs'], action: Action): ElasticsearchQuery['bucketAggs'] => {
if (addBucketAggregation.match(action)) {
const newAgg: Terms = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ describe('ElasticsearchQueryContext', () => {
expect(changedQuery.alias).toBeDefined();
expect(changedQuery.metrics).toBeDefined();
expect(changedQuery.bucketAggs).toBeDefined();

// Should also set timeField to the configured `timeField` option in datasource configuration
expect(changedQuery.timeField).toBe(datasource.timeField);

Expand Down
4 changes: 2 additions & 2 deletions src/components/QueryEditor/ElasticsearchQueryContext.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ export const ElasticsearchProvider = ({
});

const dispatch = useStatelessReducer(
// timeField is part of the query model, but its value is always set to be the one from datasource settings.
(newState) => onStateChange({ ...query, ...newState, timeField: datasource.timeField }),
// timeField is part of the query model, but its value is always set to be the one from datasource settings.
(newState) => onStateChange({ ...query, ...newState, timeField: datasource.timeField }),
query,
reducer
);
Expand Down
1 change: 0 additions & 1 deletion src/configuration/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { QuickwitOptions } from 'quickwit';
export function createDefaultConfigOptions(): DataSourceSettings<QuickwitOptions> {
return createDatasourceSettings<QuickwitOptions>({
timeField: 'timestamp',
timeOutputFormat: 'unix_timestamp_millisecs',
logMessageField: 'test.message',
logLevelField: 'test.level',
index: 'test',
Expand Down
Loading