import { createAggregationOperation, createAggregationOperationWithParam, getPromAndLokiOperationDisplayName, } from '../../prometheus/querybuilder/shared/operationUtils'; import { QueryBuilderOperation, QueryBuilderOperationDef, QueryBuilderOperationParamDef, VisualQueryModeller, } from '../../prometheus/querybuilder/shared/types'; import { FUNCTIONS } from '../syntax'; import { binaryScalarOperations } from './binaryScalarOperations'; import { LokiOperationId, LokiOperationOrder, LokiVisualQuery, LokiVisualQueryOperationCategory } from './types'; export function getOperationDefinitions(): QueryBuilderOperationDef[] { const aggregations = [ LokiOperationId.Sum, LokiOperationId.Min, LokiOperationId.Max, LokiOperationId.Avg, LokiOperationId.Stddev, LokiOperationId.Stdvar, LokiOperationId.Count, ].flatMap((opId) => createAggregationOperation(opId, { addOperationHandler: addLokiOperation, orderRank: LokiOperationOrder.Last, }) ); const aggregationsWithParam = [LokiOperationId.TopK, LokiOperationId.BottomK].flatMap((opId) => { return createAggregationOperationWithParam( opId, { params: [{ name: 'K-value', type: 'number' }], defaultParams: [5], }, { addOperationHandler: addLokiOperation, orderRank: LokiOperationOrder.Last, } ); }); const list: QueryBuilderOperationDef[] = [ createRangeOperation(LokiOperationId.Rate), createRangeOperation(LokiOperationId.CountOverTime), createRangeOperation(LokiOperationId.SumOverTime), createRangeOperation(LokiOperationId.BytesRate), createRangeOperation(LokiOperationId.BytesOverTime), createRangeOperation(LokiOperationId.AbsentOverTime), createRangeOperation(LokiOperationId.AvgOverTime), createRangeOperation(LokiOperationId.MaxOverTime), createRangeOperation(LokiOperationId.MinOverTime), createRangeOperation(LokiOperationId.FirstOverTime), createRangeOperation(LokiOperationId.LastOverTime), createRangeOperation(LokiOperationId.StdvarOverTime), createRangeOperation(LokiOperationId.StddevOverTime), createRangeOperation(LokiOperationId.QuantileOverTime), ...aggregations, ...aggregationsWithParam, { id: LokiOperationId.Json, name: 'Json', params: [], defaultParams: [], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: pipelineRenderer, addOperationHandler: addLokiOperation, }, { id: LokiOperationId.Logfmt, name: 'Logfmt', params: [], defaultParams: [], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: pipelineRenderer, addOperationHandler: addLokiOperation, explainHandler: () => `This will extract all keys and values from a [logfmt](https://grafana.com/docs/loki/latest/logql/log_queries/#logfmt) formatted log line as labels. The extracted labels can be used in label filter expressions and used as values for a range aggregation via the unwrap operation.`, }, { id: LokiOperationId.Regexp, name: 'Regexp', params: [ { name: 'String', type: 'string', hideName: true, placeholder: '', description: 'The regexp expression that matches the structure of a log line.', minWidth: 20, }, ], defaultParams: [''], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: (model, def, innerExpr) => `${innerExpr} | regexp \`${model.params[0]}\``, addOperationHandler: addLokiOperation, explainHandler: () => `The [regexp parser](https://grafana.com/docs/loki/latest/logql/log_queries/#regular-expression) takes a single parameter | regexp "" which is the regular expression using the Golang RE2 syntax. The regular expression must contain a least one named sub-match (e.g (?Pre)), each sub-match will extract a different label. The expression matches the structure of a log line. The extracted labels can be used in label filter expressions and used as values for a range aggregation via the unwrap operation.`, }, { id: LokiOperationId.Pattern, name: 'Pattern', params: [ { name: 'String', type: 'string', hideName: true, placeholder: '', description: 'The expression that matches the structure of a log line.', minWidth: 20, }, ], defaultParams: [''], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: (model, def, innerExpr) => `${innerExpr} | pattern \`${model.params[0]}\``, addOperationHandler: addLokiOperation, explainHandler: () => `The [pattern parser](https://grafana.com/docs/loki/latest/logql/log_queries/#pattern) allows the explicit extraction of fields from log lines by defining a pattern expression (| pattern \`\`). The expression matches the structure of a log line. The extracted labels can be used in label filter expressions and used as values for a range aggregation via the unwrap operation.`, }, { id: LokiOperationId.Unpack, name: 'Unpack', params: [], defaultParams: [], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: pipelineRenderer, addOperationHandler: addLokiOperation, explainHandler: () => `This will extract all keys and values from a JSON log line, [unpacking](https://grafana.com/docs/loki/latest/logql/log_queries/#unpack) all embedded labels in the pack stage. The extracted labels can be used in label filter expressions and used as values for a range aggregation via the unwrap operation.`, }, { id: LokiOperationId.LineFormat, name: 'Line format', params: [ { name: 'String', type: 'string', hideName: true, placeholder: '{{.status_code}}', description: 'A line template that can refer to stream labels and extracted labels.', minWidth: 20, }, ], defaultParams: [''], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: (model, def, innerExpr) => `${innerExpr} | line_format \`${model.params[0]}\``, addOperationHandler: addLokiOperation, explainHandler: () => `This will replace log line using a specified template. The template can refer to stream labels and extracted labels. Example: \`{{.status_code}} - {{.message}}\` [Read the docs](https://grafana.com/docs/loki/latest/logql/log_queries/#line-format-expression) for more. `, }, { id: LokiOperationId.LabelFormat, name: 'Label format', params: [ { name: 'Label', type: 'string' }, { name: 'Rename', type: 'string' }, ], defaultParams: ['', ''], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.LineFormats, renderer: (model, def, innerExpr) => `${innerExpr} | label_format ${model.params[1]}=\`${model.params[0]}\``, addOperationHandler: addLokiOperation, explainHandler: () => `This will change name of label to desired new label. In the example below, label "error_level" will be renamed to "level". Example: error_level=\`level\` [Read the docs](https://grafana.com/docs/loki/latest/logql/log_queries/#labels-format-expression) for more. `, }, { id: LokiOperationId.LineContains, name: 'Line contains', params: [ { name: 'String', type: 'string', hideName: true, placeholder: 'Text to find', description: 'Find log lines that contains this text', minWidth: 20, runQueryOnEnter: true, }, ], defaultParams: [''], alternativesKey: 'line filter', category: LokiVisualQueryOperationCategory.LineFilters, orderRank: LokiOperationOrder.LineFilters, renderer: getLineFilterRenderer('|='), addOperationHandler: addLokiOperation, explainHandler: (op) => `Return log lines that contain string \`${op.params[0]}\`.`, }, { id: LokiOperationId.LineContainsNot, name: 'Line does not contain', params: [ { name: 'String', type: 'string', hideName: true, placeholder: 'Text to exclude', description: 'Find log lines that does not contain this text', minWidth: 26, runQueryOnEnter: true, }, ], defaultParams: [''], alternativesKey: 'line filter', category: LokiVisualQueryOperationCategory.LineFilters, orderRank: LokiOperationOrder.LineFilters, renderer: getLineFilterRenderer('!='), addOperationHandler: addLokiOperation, explainHandler: (op) => `Return log lines that does not contain string \`${op.params[0]}\`.`, }, { id: LokiOperationId.LineMatchesRegex, name: 'Line contains regex match', params: [ { name: 'Regex', type: 'string', hideName: true, placeholder: 'Pattern to match', description: 'Find log lines that match this regex pattern', minWidth: 30, runQueryOnEnter: true, }, ], defaultParams: [''], alternativesKey: 'line filter', category: LokiVisualQueryOperationCategory.LineFilters, orderRank: LokiOperationOrder.LineFilters, renderer: getLineFilterRenderer('|~'), addOperationHandler: addLokiOperation, explainHandler: (op) => `Return log lines that match regex \`${op.params[0]}\`.`, }, { id: LokiOperationId.LineMatchesRegexNot, name: 'Line does not match regex', params: [ { name: 'Regex', type: 'string', hideName: true, placeholder: 'Pattern to exclude', description: 'Find log lines that does not match this regex pattern', minWidth: 30, runQueryOnEnter: true, }, ], defaultParams: [''], alternativesKey: 'line filter', category: LokiVisualQueryOperationCategory.LineFilters, orderRank: LokiOperationOrder.LineFilters, renderer: getLineFilterRenderer('!~'), addOperationHandler: addLokiOperation, explainHandler: (op) => `Return log lines that does not match regex \`${op.params[0]}\`.`, }, { id: LokiOperationId.LabelFilter, name: 'Label filter expression', params: [ { name: 'Label', type: 'string' }, { name: 'Operator', type: 'string', options: ['=', '!=', ' =~', '!~', '>', '<', '>=', '<='] }, { name: 'Value', type: 'string' }, ], defaultParams: ['', '=', ''], alternativesKey: 'label filter', category: LokiVisualQueryOperationCategory.LabelFilters, orderRank: LokiOperationOrder.LabelFilters, renderer: labelFilterRenderer, addOperationHandler: addLokiOperation, explainHandler: () => `Label expression filter allows filtering using original and extracted labels.`, }, { id: LokiOperationId.LabelFilterNoErrors, name: 'No pipeline errors', params: [], defaultParams: [], alternativesKey: 'label filter', category: LokiVisualQueryOperationCategory.LabelFilters, orderRank: LokiOperationOrder.NoErrors, renderer: (model, def, innerExpr) => `${innerExpr} | __error__=\`\``, addOperationHandler: addLokiOperation, explainHandler: () => `Filter out all formatting and parsing errors.`, }, { id: LokiOperationId.Unwrap, name: 'Unwrap', params: [{ name: 'Identifier', type: 'string', hideName: true, minWidth: 16, placeholder: 'Label key' }], defaultParams: [''], alternativesKey: 'format', category: LokiVisualQueryOperationCategory.Formats, orderRank: LokiOperationOrder.Unwrap, renderer: (op, def, innerExpr) => `${innerExpr} | unwrap ${op.params[0]}`, addOperationHandler: addLokiOperation, explainHandler: (op) => { let label = String(op.params[0]).length > 0 ? op.params[0] : '