import { sortBy } from 'lodash'; import { JsonExpressionParser, LabelFilter, LabelParser, LineComment, LineFilters, LogExpr, LogRangeExpr, parser, PipelineExpr, Selector, UnwrapExpr, } from '@grafana/lezer-logql'; import { QueryBuilderLabelFilter } from '../prometheus/querybuilder/shared/types'; import { LokiQueryModeller } from './querybuilder/LokiQueryModeller'; import { buildVisualQueryFromString } from './querybuilder/parsing'; type Position = { from: number; to: number }; /** * Adds label filter to existing query. Useful for query modification for example for ad hoc filters. * * It uses LogQL parser to find instances of labels, alters them and then splices them back into the query. * In a case when we have parser, instead of adding new instance of label it adds label filter after the parser. * * This operates on substrings of the query with labels and operates just on those. This makes this * more robust and can alter even invalid queries, and preserves in general the query structure and whitespace. * * @param query * @param key * @param value * @param operator */ export function addLabelToQuery(query: string, key: string, operator: string, value: string): string { if (!key || !value) { throw new Error('Need label to add to query.'); } const streamSelectorPositions = getStreamSelectorPositions(query); const parserPositions = getParserPositions(query); const labelFilterPositions = getLabelFilterPositions(query); if (!streamSelectorPositions.length) { return query; } const filter = toLabelFilter(key, value, operator); // If we have label filters or parser, we want to add new label filter after the last one if (labelFilterPositions.length || parserPositions.length) { const positionToAdd = findLastPosition([...labelFilterPositions, ...parserPositions]); return addFilterAsLabelFilter(query, [positionToAdd], filter); } else { return addFilterToStreamSelector(query, streamSelectorPositions, filter); } } /** * Adds parser to existing query. Useful for query modification for hints. * It uses LogQL parser to find instances of stream selectors or line filters and adds parser after them. * * @param query * @param parser */ export function addParserToQuery(query: string, parser: string): string { const lineFilterPositions = getLineFiltersPositions(query); if (lineFilterPositions.length) { return addParser(query, lineFilterPositions, parser); } else { const streamSelectorPositions = getStreamSelectorPositions(query); return addParser(query, streamSelectorPositions, parser); } } /** * Adds filtering for pipeline errors to existing query. Useful for query modification for hints. * It uses LogQL parser to find parsers and adds pipeline errors filtering after them. * * @param query */ export function addNoPipelineErrorToQuery(query: string): string { const parserPositions = getParserPositions(query); if (!parserPositions.length) { return query; } const filter = toLabelFilter('__error__', '', '='); return addFilterAsLabelFilter(query, parserPositions, filter); } /** * Adds label format to existing query. Useful for query modification for hints. * It uses LogQL parser to find log query and add label format at the end. * * @param query * @param labelFormat */ export function addLabelFormatToQuery(query: string, labelFormat: { originalLabel: string; renameTo: string }): string { const logQueryPositions = getLogQueryPositions(query); return addLabelFormat(query, logQueryPositions, labelFormat); } /** * Removes all comments from query. * It uses LogQL parser to find all LineComments and removes them. */ export function removeCommentsFromQuery(query: string): string { const lineCommentPositions = getLineCommentPositions(query); if (!lineCommentPositions.length) { return query; } let newQuery = ''; let prev = 0; for (let lineCommentPosition of lineCommentPositions) { const beforeComment = query.substring(prev, lineCommentPosition.from); const afterComment = query.substring(lineCommentPosition.to); newQuery += beforeComment + afterComment; prev = lineCommentPosition.to; } return newQuery; } /** * Parse the string and get all Selector positions in the query together with parsed representation of the * selector. * @param query */ function getStreamSelectorPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, from, to }): false | void => { if (type.id === Selector) { positions.push({ from, to }); return false; } }, }); return positions; } /** * Parse the string and get all LabelParser positions in the query. * @param query */ export function getParserPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, from, to }): false | void => { if (type.id === LabelParser || type.id === JsonExpressionParser) { positions.push({ from, to }); return false; } }, }); return positions; } /** * Parse the string and get all LabelFilter positions in the query. * @param query */ export function getLabelFilterPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, from, to }): false | void => { if (type.id === LabelFilter) { positions.push({ from, to }); return false; } }, }); return positions; } /** * Parse the string and get all Line filter positions in the query. * @param query */ function getLineFiltersPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, node }): false | void => { if (type.id === LineFilters) { positions.push({ from: node.from, to: node.to }); return false; } }, }); return positions; } /** * Parse the string and get all Log query positions in the query. * @param query */ function getLogQueryPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, from, to, node }): false | void => { if (type.id === LogExpr) { positions.push({ from, to }); return false; } // This is a case in metrics query if (type.id === LogRangeExpr) { // Unfortunately, LogRangeExpr includes both log and non-log (e.g. Duration/Range/...) parts of query. // We get position of all log-parts within LogRangeExpr: Selector, PipelineExpr and UnwrapExpr. const logPartsPositions: Position[] = []; const selector = node.getChild(Selector); if (selector) { logPartsPositions.push({ from: selector.from, to: selector.to }); } const pipeline = node.getChild(PipelineExpr); if (pipeline) { logPartsPositions.push({ from: pipeline.from, to: pipeline.to }); } const unwrap = node.getChild(UnwrapExpr); if (unwrap) { logPartsPositions.push({ from: unwrap.from, to: unwrap.to }); } // We sort them and then pick "from" from first position and "to" from last position. const sorted = sortBy(logPartsPositions, (position) => position.to); positions.push({ from: sorted[0].from, to: sorted[sorted.length - 1].to }); return false; } }, }); return positions; } function toLabelFilter(key: string, value: string, operator: string): QueryBuilderLabelFilter { // We need to make sure that we convert the value back to string because it may be a number return { label: key, op: operator, value }; } /** * Add filter as to stream selectors * @param query * @param vectorSelectorPositions * @param filter */ function addFilterToStreamSelector( query: string, vectorSelectorPositions: Position[], filter: QueryBuilderLabelFilter ): string { const modeller = new LokiQueryModeller(); let newQuery = ''; let prev = 0; for (let i = 0; i < vectorSelectorPositions.length; i++) { // This is basically just doing splice on a string for each matched vector selector. const match = vectorSelectorPositions[i]; const isLast = i === vectorSelectorPositions.length - 1; const start = query.substring(prev, match.from); const end = isLast ? query.substring(match.to) : ''; const matchVisQuery = buildVisualQueryFromString(query.substring(match.from, match.to)); if (!labelExists(matchVisQuery.query.labels, filter)) { // We don't want to add duplicate labels. matchVisQuery.query.labels.push(filter); } const newLabels = modeller.renderQuery(matchVisQuery.query); newQuery += start + newLabels + end; prev = match.to; } return newQuery; } /** * Add filter as label filter after the parsers * @param query * @param positionsToAddAfter * @param filter */ function addFilterAsLabelFilter( query: string, positionsToAddAfter: Position[], filter: QueryBuilderLabelFilter ): string { let newQuery = ''; let prev = 0; for (let i = 0; i < positionsToAddAfter.length; i++) { // This is basically just doing splice on a string for each matched vector selector. const match = positionsToAddAfter[i]; const isLast = i === positionsToAddAfter.length - 1; const start = query.substring(prev, match.to); const end = isLast ? query.substring(match.to) : ''; const labelFilter = ` | ${filter.label}${filter.op}\`${filter.value}\``; newQuery += start + labelFilter + end; prev = match.to; } return newQuery; } /** * Add parser after line filter or stream selector * @param query * @param queryPartPositions * @param parser */ function addParser(query: string, queryPartPositions: Position[], parser: string): string { let newQuery = ''; let prev = 0; for (let i = 0; i < queryPartPositions.length; i++) { // Splice on a string for each matched vector selector const match = queryPartPositions[i]; const isLast = i === queryPartPositions.length - 1; const start = query.substring(prev, match.to); const end = isLast ? query.substring(match.to) : ''; // Add parser newQuery += start + ` | ${parser}` + end; prev = match.to; } return newQuery; } /** * Add filter as label filter after the parsers * @param query * @param logQueryPositions * @param labelFormat */ function addLabelFormat( query: string, logQueryPositions: Position[], labelFormat: { originalLabel: string; renameTo: string } ): string { let newQuery = ''; let prev = 0; for (let i = 0; i < logQueryPositions.length; i++) { // This is basically just doing splice on a string for each matched vector selector. const match = logQueryPositions[i]; const isLast = i === logQueryPositions.length - 1; const start = query.substring(prev, match.to); const end = isLast ? query.substring(match.to) : ''; const labelFilter = ` | label_format ${labelFormat.renameTo}=${labelFormat.originalLabel}`; newQuery += start + labelFilter + end; prev = match.to; } return newQuery; } function getLineCommentPositions(query: string): Position[] { const tree = parser.parse(query); const positions: Position[] = []; tree.iterate({ enter: ({ type, from, to }): false | void => { if (type.id === LineComment) { positions.push({ from, to }); return false; } }, }); return positions; } /** * Check if label exists in the list of labels but ignore the operator. * @param labels * @param filter */ function labelExists(labels: QueryBuilderLabelFilter[], filter: QueryBuilderLabelFilter) { return labels.find((label) => label.label === filter.label && label.value === filter.value); } /** * Return the last position based on "to" property * @param positions */ function findLastPosition(positions: Position[]): Position { return positions.reduce((prev, current) => (prev.to > current.to ? prev : current)); }