debian-mirror-gitlab/app/assets/javascripts/monitoring/stores/utils.js

248 lines
6.9 KiB
JavaScript
Raw Normal View History

2020-04-08 14:13:33 +05:30
import { slugify } from '~/lib/utils/text_utility';
2020-03-13 15:44:24 +05:30
import createGqClient, { fetchPolicies } from '~/lib/graphql';
2020-04-08 14:13:33 +05:30
import { SUPPORTED_FORMATS } from '~/lib/utils/unit_format';
2020-03-13 15:44:24 +05:30
import { getIdFromGraphQLId } from '~/graphql_shared/utils';
2020-04-22 19:07:51 +05:30
import { NOT_IN_DB_PREFIX } from '../constants';
2020-03-13 15:44:24 +05:30
export const gqClient = createGqClient(
{},
{
fetchPolicy: fetchPolicies.NO_CACHE,
},
);
2017-09-10 17:25:29 +05:30
2020-04-08 14:13:33 +05:30
/**
* Metrics loaded from project-defined dashboards do not have a metric_id.
* This method creates a unique ID combining metric_id and id, if either is present.
* This is hopefully a temporary solution until BE processes metrics before passing to FE
2020-04-22 19:07:51 +05:30
*
* Related:
* https://gitlab.com/gitlab-org/gitlab/-/issues/28241
* https://gitlab.com/gitlab-org/gitlab/-/merge_requests/27447
*
2020-04-08 14:13:33 +05:30
* @param {Object} metric - metric
2020-04-22 19:07:51 +05:30
* @param {Number} metric.metric_id - Database metric id
* @param {String} metric.id - User-defined identifier
2020-04-08 14:13:33 +05:30
* @returns {Object} - normalized metric with a uniqueID
*/
// eslint-disable-next-line babel/camelcase
2020-04-22 19:07:51 +05:30
export const uniqMetricsId = ({ metric_id, id }) => `${metric_id || NOT_IN_DB_PREFIX}_${id}`;
2019-12-21 20:55:43 +05:30
2020-03-13 15:44:24 +05:30
/**
* Project path has a leading slash that doesn't work well
* with project full path resolver here
* https://gitlab.com/gitlab-org/gitlab/blob/5cad4bd721ab91305af4505b2abc92b36a56ad6b/app/graphql/resolvers/full_path_resolver.rb#L10
*
* @param {String} str String with leading slash
* @returns {String}
*/
export const removeLeadingSlash = str => (str || '').replace(/^\/+/, '');
/**
* GraphQL environments API returns only id and name.
* For the environments dropdown we need metrics_path.
* This method parses the results and add neccessart attrs
*
* @param {Array} response Environments API result
* @param {String} projectPath Current project path
* @returns {Array}
*/
export const parseEnvironmentsResponse = (response = [], projectPath) =>
(response || []).map(env => {
const id = getIdFromGraphQLId(env.id);
return {
...env,
id,
metrics_path: `${projectPath}/environments/${id}/metrics`,
};
});
2020-04-22 19:07:51 +05:30
/**
* Annotation API returns time in UTC. This method
* converts time to local time.
*
* startingAt always exists but endingAt does not.
* If endingAt does not exist, a threshold line is
* drawn.
*
* If endingAt exists, a threshold range is drawn.
* But this is not supported as of %12.10
*
* @param {Array} response annotations response
* @returns {Array} parsed responses
*/
export const parseAnnotationsResponse = response => {
if (!response) {
return [];
}
return response.map(annotation => ({
...annotation,
startingAt: new Date(annotation.startingAt),
endingAt: annotation.endingAt ? new Date(annotation.endingAt) : null,
}));
};
2019-12-21 20:55:43 +05:30
/**
2020-04-08 14:13:33 +05:30
* Maps metrics to its view model
*
* This function difers from other in that is maps all
* non-define properties as-is to the object. This is not
* advisable as it could lead to unexpected side-effects.
*
* Related issue:
* https://gitlab.com/gitlab-org/gitlab/issues/207198
*
* @param {Array} metrics - Array of prometheus metrics
* @returns {Object}
2019-12-21 20:55:43 +05:30
*/
2020-04-22 19:07:51 +05:30
const mapToMetricsViewModel = metrics =>
2020-04-08 14:13:33 +05:30
metrics.map(({ label, id, metric_id, query_range, prometheus_endpoint_path, ...metric }) => ({
2020-04-22 19:07:51 +05:30
label,
2020-04-08 14:13:33 +05:30
queryRange: query_range,
prometheusEndpointPath: prometheus_endpoint_path,
metricId: uniqMetricsId({ metric_id, id }),
2020-04-22 19:07:51 +05:30
// metric data
loading: false,
result: null,
state: null,
2020-04-08 14:13:33 +05:30
...metric,
}));
2020-01-01 13:55:28 +05:30
2020-04-08 14:13:33 +05:30
/**
2020-04-22 19:07:51 +05:30
* Maps X-axis view model
2020-04-08 14:13:33 +05:30
*
2020-04-22 19:07:51 +05:30
* @param {Object} axis
*/
const mapXAxisToViewModel = ({ name = '' }) => ({ name });
/**
* Maps Y-axis view model
*
* Defaults to a 2 digit precision and `engineering` format. It only allows
2020-04-08 14:13:33 +05:30
* formats in the SUPPORTED_FORMATS array.
*
* @param {Object} axis
*/
2020-04-22 19:07:51 +05:30
const mapYAxisToViewModel = ({
name = '',
format = SUPPORTED_FORMATS.engineering,
precision = 2,
}) => {
2020-04-08 14:13:33 +05:30
return {
name,
2020-04-22 19:07:51 +05:30
format: SUPPORTED_FORMATS[format] || SUPPORTED_FORMATS.engineering,
2020-04-08 14:13:33 +05:30
precision,
};
};
/**
* Maps a metrics panel to its view model
*
* @param {Object} panel - Metrics panel
* @returns {Object}
*/
2020-04-22 19:07:51 +05:30
const mapPanelToViewModel = ({
2020-05-24 23:13:21 +05:30
id = null,
2020-04-22 19:07:51 +05:30
title = '',
type,
x_axis = {},
x_label,
y_label,
y_axis = {},
metrics = [],
max_value,
}) => {
// Both `x_axis.name` and `x_label` are supported for now
// https://gitlab.com/gitlab-org/gitlab/issues/210521
const xAxis = mapXAxisToViewModel({ name: x_label, ...x_axis }); // eslint-disable-line babel/camelcase
2020-04-08 14:13:33 +05:30
// Both `y_axis.name` and `y_label` are supported for now
// https://gitlab.com/gitlab-org/gitlab/issues/208385
2020-04-22 19:07:51 +05:30
const yAxis = mapYAxisToViewModel({ name: y_label, ...y_axis }); // eslint-disable-line babel/camelcase
2020-04-08 14:13:33 +05:30
return {
2020-05-24 23:13:21 +05:30
id,
2020-04-08 14:13:33 +05:30
title,
type,
2020-04-22 19:07:51 +05:30
xLabel: xAxis.name,
2020-04-08 14:13:33 +05:30
y_label: yAxis.name, // Changing y_label to yLabel is pending https://gitlab.com/gitlab-org/gitlab/issues/207198
yAxis,
2020-04-22 19:07:51 +05:30
xAxis,
maxValue: max_value,
2020-04-08 14:13:33 +05:30
metrics: mapToMetricsViewModel(metrics, yAxis.name),
};
};
/**
* Maps a metrics panel group to its view model
*
* @param {Object} panelGroup - Panel Group
* @returns {Object}
*/
const mapToPanelGroupViewModel = ({ group = '', panels = [] }, i) => {
return {
key: `${slugify(group || 'default')}-${i}`,
group,
2020-04-22 19:07:51 +05:30
panels: panels.map(mapPanelToViewModel),
2020-04-08 14:13:33 +05:30
};
};
/**
* Maps a dashboard json object to its view model
*
* @param {Object} dashboard - Dashboard object
* @param {String} dashboard.dashboard - Dashboard name object
* @param {Array} dashboard.panel_groups - Panel groups array
* @returns {Object}
*/
export const mapToDashboardViewModel = ({ dashboard = '', panel_groups = [] }) => {
return {
dashboard,
panelGroups: panel_groups.map(mapToPanelGroupViewModel),
};
};
2019-12-21 20:55:43 +05:30
2019-09-30 21:07:59 +05:30
export const normalizeQueryResult = timeSeries => {
let normalizedResult = {};
if (timeSeries.values) {
normalizedResult = {
...timeSeries,
values: timeSeries.values.map(([timestamp, value]) => [
new Date(timestamp * 1000).toISOString(),
Number(value),
]),
};
2020-01-01 13:55:28 +05:30
// Check result for empty data
normalizedResult.values = normalizedResult.values.filter(series => {
const hasValue = d => !Number.isNaN(d[1]) && (d[1] !== null || d[1] !== undefined);
return series.find(hasValue);
});
2019-09-30 21:07:59 +05:30
} else if (timeSeries.value) {
normalizedResult = {
...timeSeries,
value: [new Date(timeSeries.value[0] * 1000).toISOString(), Number(timeSeries.value[1])],
};
}
return normalizedResult;
};
2020-05-30 21:06:31 +05:30
/**
* Custom variables defined in the dashboard yml file are
* eventually passed over the wire to the backend Prometheus
* API proxy.
*
* This method adds a prefix to the URL param keys so that
* the backend can differential these variables from the other
* variables.
*
* This is currently only used by getters/getCustomVariablesParams
*
* @param {String} key Variable key that needs to be prefixed
* @returns {String}
*/
export const addPrefixToCustomVariableParams = key => `variables[${key}]`;