mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
97 lines
3.1 KiB
JavaScript
97 lines
3.1 KiB
JavaScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License;
|
|
* you may not use this file except in compliance with the Elastic License.
|
|
*/
|
|
|
|
import { defaults, get } from 'lodash';
|
|
import { MissingRequiredError } from './error_missing_required';
|
|
import moment from 'moment';
|
|
|
|
/*
|
|
* Builds a type filter syntax that supports backwards compatibility to read
|
|
* from indices before and after `_type` is removed from Elasticsearch
|
|
*
|
|
* TODO: this backwards compatibility helper will only be supported for 5.x-6. This
|
|
* function should be removed in 7.0
|
|
*/
|
|
export const createTypeFilter = (type) => {
|
|
return {
|
|
bool: {
|
|
should: [
|
|
{ term: { _type: type } },
|
|
{ term: { type } }
|
|
]
|
|
}
|
|
};
|
|
};
|
|
|
|
/*
|
|
* Creates the boilerplace for querying monitoring data, including filling in
|
|
* document UUIDs, start time and end time, and injecting additional filters.
|
|
*
|
|
* Create a bool for types that will query for documents using `_type` (true type) and `type` (as a field)
|
|
* Makes backwards compatibility for types being deprecated in Elasticsearch
|
|
*
|
|
* Options object:
|
|
* @param {String} options.type - `type` field value of the documents
|
|
* @param {Array} options.filters - additional filters to add to the `bool` section of the query. Default: []
|
|
* @param {string} options.clusterUuid - a UUID of the cluster. Required.
|
|
* @param {string} options.uuid - a UUID of the metric to filter for, or `null` if UUID should not be part of the query
|
|
* @param {Date} options.start - numeric timestamp (optional)
|
|
* @param {Date} options.end - numeric timestamp (optional)
|
|
* @param {Metric} options.metric - Metric instance or metric fields object @see ElasticsearchMetric.getMetricFields
|
|
*/
|
|
export function createQuery(options) {
|
|
options = defaults(options, { filters: [] });
|
|
const { type, clusterUuid, uuid, start, end, filters } = options;
|
|
|
|
let typeFilter;
|
|
if (type) {
|
|
typeFilter = createTypeFilter(type);
|
|
}
|
|
|
|
let clusterUuidFilter;
|
|
if (clusterUuid) {
|
|
clusterUuidFilter = { term: { 'cluster_uuid': clusterUuid } };
|
|
}
|
|
|
|
let uuidFilter;
|
|
// options.uuid can be null, for example getting all the clusters
|
|
if (uuid) {
|
|
const uuidField = get(options, 'metric.uuidField');
|
|
if (!uuidField) {
|
|
throw new MissingRequiredError('options.uuid given but options.metric.uuidField is false');
|
|
}
|
|
uuidFilter = { term: { [uuidField]: uuid } };
|
|
}
|
|
|
|
const timestampField = get(options, 'metric.timestampField');
|
|
if (!timestampField) {
|
|
throw new MissingRequiredError('metric.timestampField');
|
|
}
|
|
const timeRangeFilter = {
|
|
range: {
|
|
[timestampField]: {
|
|
format: 'epoch_millis'
|
|
}
|
|
}
|
|
};
|
|
if (start) {
|
|
timeRangeFilter.range[timestampField].gte = moment.utc(start).valueOf();
|
|
}
|
|
if (end) {
|
|
timeRangeFilter.range[timestampField].lte = moment.utc(end).valueOf();
|
|
}
|
|
|
|
const combinedFilters = [typeFilter, clusterUuidFilter, uuidFilter, ...filters];
|
|
if (end || start) {
|
|
combinedFilters.push(timeRangeFilter);
|
|
}
|
|
|
|
return {
|
|
bool: {
|
|
filter: combinedFilters.filter(Boolean)
|
|
}
|
|
};
|
|
}
|