import _ from 'lodash'; import React, { ReactNode } from 'react'; import { Plugin } from 'slate'; import { ButtonCascader, CascaderOption, SlatePrism, TypeaheadInput, TypeaheadOutput, QueryField, BracesPlugin, } from '@grafana/ui'; import { LanguageMap, languages as prismLanguages } from 'prismjs'; // dom also includes Element polyfills import { PromQuery, PromOptions, PromMetricsMetadata } from '../types'; import { roundMsToMin } from '../language_utils'; import { CancelablePromise, makePromiseCancelable } from 'app/core/utils/CancelablePromise'; import { ExploreQueryFieldProps, QueryHint, isDataFrame, toLegacyResponseData, HistoryItem, TimeRange, } from '@grafana/data'; import { DOMUtil, SuggestionsState } from '@grafana/ui'; import { PrometheusDatasource } from '../datasource'; const HISTOGRAM_GROUP = '__histograms__'; export const RECORDING_RULES_GROUP = '__recording_rules__'; function getChooserText(metricsLookupDisabled: boolean, hasSyntax: boolean, metrics: string[]) { if (metricsLookupDisabled) { return '(Disabled)'; } if (!hasSyntax) { return 'Loading metrics...'; } if (metrics && metrics.length === 0) { return '(No metrics found)'; } return 'Metrics'; } function addMetricsMetadata(metric: string, metadata?: PromMetricsMetadata): CascaderOption { const option: CascaderOption = { label: metric, value: metric }; if (metadata && metadata[metric]) { const { type = '', help } = metadata[metric][0]; option.title = [metric, type.toUpperCase(), help].join('\n'); } return option; } export function groupMetricsByPrefix(metrics: string[], metadata?: PromMetricsMetadata): CascaderOption[] { // Filter out recording rules and insert as first option const ruleRegex = /:\w+:/; const ruleNames = metrics.filter((metric) => ruleRegex.test(metric)); const rulesOption = { label: 'Recording rules', value: RECORDING_RULES_GROUP, children: ruleNames .slice() .sort() .map((name) => ({ label: name, value: name })), }; const options = ruleNames.length > 0 ? [rulesOption] : []; const delimiter = '_'; const metricsOptions = _.chain(metrics) .filter((metric: string) => !ruleRegex.test(metric)) .groupBy((metric: string) => metric.split(delimiter)[0]) .map( (metricsForPrefix: string[], prefix: string): CascaderOption => { const prefixIsMetric = metricsForPrefix.length === 1 && metricsForPrefix[0] === prefix; const children = prefixIsMetric ? [] : metricsForPrefix.sort().map((m) => addMetricsMetadata(m, metadata)); return { children, label: prefix, value: prefix, }; } ) .sortBy('label') .value(); return [...options, ...metricsOptions]; } export function willApplySuggestion(suggestion: string, { typeaheadContext, typeaheadText }: SuggestionsState): string { // Modify suggestion based on context switch (typeaheadContext) { case 'context-labels': { const nextChar = DOMUtil.getNextCharacter(); if (!nextChar || nextChar === '}' || nextChar === ',') { suggestion += '='; } break; } case 'context-label-values': { // Always add quotes and remove existing ones instead if (!typeaheadText.match(/^(!?=~?"|")/)) { suggestion = `"${suggestion}`; } if (DOMUtil.getNextCharacter() !== '"') { suggestion = `${suggestion}"`; } break; } default: } return suggestion; } interface PromQueryFieldProps extends ExploreQueryFieldProps { history: Array>; ExtraFieldElement?: ReactNode; } interface PromQueryFieldState { metricsOptions: any[]; syntaxLoaded: boolean; hint: QueryHint | null; } class PromQueryField extends React.PureComponent { plugins: Plugin[]; languageProviderInitializationPromise: CancelablePromise; constructor(props: PromQueryFieldProps, context: React.Context) { super(props, context); this.plugins = [ BracesPlugin(), SlatePrism( { onlyIn: (node: any) => node.type === 'code_block', getSyntax: (node: any) => 'promql', }, { ...(prismLanguages as LanguageMap), promql: this.props.datasource.languageProvider.syntax } ), ]; this.state = { metricsOptions: [], syntaxLoaded: false, hint: null, }; } componentDidMount() { if (this.props.datasource.languageProvider) { this.refreshMetrics(); } this.refreshHint(); } componentWillUnmount() { if (this.languageProviderInitializationPromise) { this.languageProviderInitializationPromise.cancel(); } } componentDidUpdate(prevProps: PromQueryFieldProps) { const { data, datasource: { languageProvider }, range, } = this.props; if (languageProvider !== prevProps.datasource.languageProvider) { // We reset this only on DS change so we do not flesh loading state on every rangeChange which happens on every // query run if using relative range. this.setState({ metricsOptions: [], syntaxLoaded: false, }); } const changedRangeToRefresh = this.rangeChangedToRefresh(range, prevProps.range); // We want to refresh metrics when language provider changes and/or when range changes (we round up intervals to a minute) if (languageProvider !== prevProps.datasource.languageProvider || changedRangeToRefresh) { this.refreshMetrics(); } if (data && prevProps.data && prevProps.data.series !== data.series) { this.refreshHint(); } } refreshHint = () => { const { datasource, query, data } = this.props; if (!data || data.series.length === 0) { this.setState({ hint: null }); return; } const result = isDataFrame(data.series[0]) ? data.series.map(toLegacyResponseData) : data.series; const hints = datasource.getQueryHints(query, result); let hint = hints.length > 0 ? hints[0] : null; // Hint for big disabled lookups if (!hint && datasource.lookupsDisabled) { hint = { label: `Labels and metrics lookup was disabled in data source settings.`, type: 'INFO', }; } this.setState({ hint }); }; refreshMetrics = async () => { const { datasource: { languageProvider }, } = this.props; this.languageProviderInitializationPromise = makePromiseCancelable(languageProvider.start()); try { const remainingTasks = await this.languageProviderInitializationPromise.promise; await Promise.all(remainingTasks); this.onUpdateLanguage(); } catch (err) { if (!err.isCanceled) { throw err; } } }; rangeChangedToRefresh(range?: TimeRange, prevRange?: TimeRange): boolean { if (range && prevRange) { const sameMinuteFrom = roundMsToMin(range.from.valueOf()) === roundMsToMin(prevRange.from.valueOf()); const sameMinuteTo = roundMsToMin(range.to.valueOf()) === roundMsToMin(prevRange.to.valueOf()); // If both are same, don't need to refresh. return !(sameMinuteFrom && sameMinuteTo); } return false; } onChangeMetrics = (values: string[], selectedOptions: CascaderOption[]) => { let query; if (selectedOptions.length === 1) { const selectedOption = selectedOptions[0]; if (!selectedOption.children || selectedOption.children.length === 0) { query = selectedOption.value; } else { // Ignore click on group return; } } else { const prefix = selectedOptions[0].value; const metric = selectedOptions[1].value; if (prefix === HISTOGRAM_GROUP) { query = `histogram_quantile(0.95, sum(rate(${metric}[5m])) by (le))`; } else { query = metric; } } this.onChangeQuery(query, true); }; onChangeQuery = (value: string, override?: boolean) => { // Send text change to parent const { query, onChange, onRunQuery } = this.props; if (onChange) { const nextQuery: PromQuery = { ...query, expr: value }; onChange(nextQuery); if (override && onRunQuery) { onRunQuery(); } } }; onClickHintFix = () => { const { datasource, query, onChange, onRunQuery } = this.props; const { hint } = this.state; onChange(datasource.modifyQuery(query, hint!.fix!.action)); onRunQuery(); }; onUpdateLanguage = () => { const { datasource: { languageProvider }, } = this.props; const { histogramMetrics, metrics, metricsMetadata } = languageProvider; if (!metrics) { return; } // Build metrics tree const metricsByPrefix = groupMetricsByPrefix(metrics, metricsMetadata); const histogramOptions = histogramMetrics.map((hm: any) => ({ label: hm, value: hm })); const metricsOptions = histogramMetrics.length > 0 ? [ { label: 'Histograms', value: HISTOGRAM_GROUP, children: histogramOptions, isLeaf: false }, ...metricsByPrefix, ] : metricsByPrefix; this.setState({ metricsOptions, syntaxLoaded: true }); }; onTypeahead = async (typeahead: TypeaheadInput): Promise => { const { datasource: { languageProvider }, } = this.props; if (!languageProvider) { return { suggestions: [] }; } const { history } = this.props; const { prefix, text, value, wrapperClasses, labelKey } = typeahead; const result = await languageProvider.provideCompletionItems( { text, value, prefix, wrapperClasses, labelKey }, { history } ); return result; }; render() { const { datasource, datasource: { languageProvider }, query, ExtraFieldElement, } = this.props; const { metricsOptions, syntaxLoaded, hint } = this.state; const cleanText = languageProvider ? languageProvider.cleanText : undefined; const chooserText = getChooserText(datasource.lookupsDisabled, syntaxLoaded, metricsOptions); const buttonDisabled = !(syntaxLoaded && metricsOptions && metricsOptions.length > 0); return ( <>
{chooserText}
{ExtraFieldElement} {hint ? (
{hint.label}{' '} {hint.fix ? ( {hint.fix.label} ) : null}
) : null} ); } } export default PromQueryField;