/usr/share/grafana/public/app/plugins/datasource/graphite
import { map as _map, each, indexOf, isArray, isString } from 'lodash'; import moment from 'moment'; import { lastValueFrom, merge, Observable, of, OperatorFunction, pipe, throwError } from 'rxjs'; import { catchError, map } from 'rxjs/operators'; import { coerce, gte, SemVer, valid } from 'semver'; import { AbstractLabelMatcher, AbstractLabelOperator, AbstractQuery, DataFrame, DataQueryRequest, DataQueryResponse, DataSourceWithQueryExportSupport, dateMath, DateTime, dateTime, getSearchFilterScopedVar, MetricFindValue, QueryResultMetaStat, ScopedVars, TimeRange, toDataFrame, } from '@grafana/data'; import { BackendSrvRequest, config, DataSourceWithBackend, FetchResponse, getBackendSrv, getTemplateSrv, TemplateSrv, } from '@grafana/runtime'; import { TimeZone } from '@grafana/schema'; import { AnnotationEditor } from './components/AnnotationsEditor'; import { convertToGraphiteQueryObject } from './components/helpers'; import gfunc, { FuncDef, FuncDefs, FuncInstance } from './gfunc'; import GraphiteQueryModel from './graphite_query'; import { getRollupNotice, getRuntimeConsolidationNotice } from './meta'; import { prepareAnnotation } from './migrations'; // Types import { GraphiteEvents, GraphiteLokiMapping, GraphiteMetricLokiMatcher, GraphiteOptions, GraphiteQuery, GraphiteQueryImportConfiguration, GraphiteQueryType, GraphiteType, MetricTankRequestMeta, MetricTankSeriesMeta, } from './types'; import { reduceError } from './utils'; import { DEFAULT_GRAPHITE_VERSION } from './versions'; const GRAPHITE_TAG_COMPARATORS = { '=': AbstractLabelOperator.Equal, '!=': AbstractLabelOperator.NotEqual, '=~': AbstractLabelOperator.EqualRegEx, '!=~': AbstractLabelOperator.NotEqualRegEx, }; /** * Converts Graphite glob-like pattern to a regular expression */ function convertGlobToRegEx(text: string): string { if (text.includes('*') || text.includes('{')) { return '^' + text.replace(/\*/g, '.*').replace(/\{/g, '(').replace(/}/g, ')').replace(/,/g, '|'); } else { return text; } } export class GraphiteDatasource extends DataSourceWithBackend<GraphiteQuery, GraphiteOptions> implements DataSourceWithQueryExportSupport<GraphiteQuery> { basicAuth: string; url: string; name: string; graphiteVersion: string; supportsTags: boolean; isMetricTank: boolean; rollupIndicatorEnabled: boolean; cacheTimeout: number; withCredentials: boolean; funcDefs: FuncDefs | null = null; funcDefsPromise: Promise<FuncDefs> | null = null; _seriesRefLetters: string; requestCounter = 100; private readonly metricMappings: GraphiteLokiMapping[]; constructor( instanceSettings: any, private readonly templateSrv: TemplateSrv = getTemplateSrv() ) { super(instanceSettings); this.basicAuth = instanceSettings.basicAuth; this.url = instanceSettings.url; this.name = instanceSettings.name; // graphiteVersion is set when a datasource is created but it hadn't been set in the past so we're // still falling back to the default behavior here for backwards compatibility (see also #17429) this.graphiteVersion = instanceSettings.jsonData.graphiteVersion || DEFAULT_GRAPHITE_VERSION; this.metricMappings = instanceSettings.jsonData.importConfiguration?.loki?.mappings || []; this.isMetricTank = instanceSettings.jsonData.graphiteType === GraphiteType.Metrictank; this.supportsTags = supportsTags(this.graphiteVersion); this.cacheTimeout = instanceSettings.cacheTimeout; this.rollupIndicatorEnabled = instanceSettings.jsonData.rollupIndicatorEnabled; this.withCredentials = instanceSettings.withCredentials; this.funcDefs = null; this.funcDefsPromise = null; this._seriesRefLetters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; this.annotations = { QueryEditor: AnnotationEditor, prepareAnnotation, }; } getQueryOptionsInfo() { return { maxDataPoints: true, cacheTimeout: true, links: [ { text: 'Help', url: 'http://docs.grafana.org/features/datasources/graphite/#using-graphite-in-grafana', }, ], }; } getImportQueryConfiguration(): GraphiteQueryImportConfiguration { return { loki: { mappings: this.metricMappings, }, }; } async exportToAbstractQueries(queries: GraphiteQuery[]): Promise<AbstractQuery[]> { return queries.map((query) => this.exportToAbstractQuery(query)); } exportToAbstractQuery(query: GraphiteQuery): AbstractQuery { const graphiteQuery: GraphiteQueryModel = new GraphiteQueryModel( this, { ...query, target: query.target || '', textEditor: false, }, this.templateSrv ); graphiteQuery.parseTarget(); let labels: AbstractLabelMatcher[] = []; const config = this.getImportQueryConfiguration().loki; if (graphiteQuery.seriesByTagUsed) { graphiteQuery.tags.forEach((tag) => { labels.push({ name: tag.key, operator: GRAPHITE_TAG_COMPARATORS[tag.operator], value: tag.value, }); }); } else { const targetNodes = graphiteQuery.segments.map((segment) => segment.value); let mappings = config.mappings.filter((mapping) => mapping.matchers.length <= targetNodes.length); for (let mapping of mappings) { const matchers = mapping.matchers.concat(); matchers.every((matcher: GraphiteMetricLokiMatcher, index: number) => { if (matcher.labelName) { let value = (targetNodes[index] as string)!; if (value === '*') { return true; } const converted = convertGlobToRegEx(value); labels.push({ name: matcher.labelName, operator: converted !== value ? AbstractLabelOperator.EqualRegEx : AbstractLabelOperator.Equal, value: converted, }); return true; } return targetNodes[index] === matcher.value || matcher.value === '*'; }); } } return { refId: query.refId, labelMatchers: labels, }; } filterQuery(item: GraphiteQuery): boolean { if (!item.target && !item.fromAnnotations) { return false; } return true; } // Note that we do not omit queries with the hide flag set to true to avoid breaking nested series replacement // e.g. sumSeries(#A) where A is hidden applyTemplateVariables(target: GraphiteQuery, scopedVars: ScopedVars) { return { ...target, target: this.templateSrv.replace(target.target ?? '', scopedVars), targetFull: this.templateSrv.replace(target.targetFull ?? '', scopedVars), }; } frontendQuery( options: DataQueryRequest<GraphiteQuery>, originalTargetMap: { [key: string]: string }, formattedRefIdsMap: { [key: string]: string } ): Observable<DataQueryResponse> { // handle the queries here const graphOptions = { from: this.translateTime(options.range.from, false, options.timezone), until: this.translateTime(options.range.to, true, options.timezone), targets: options.targets, format: 'json', cacheTimeout: options.cacheTimeout || this.cacheTimeout, maxDataPoints: options.maxDataPoints, }; const params = this.buildGraphiteParams(graphOptions, originalTargetMap, options.scopedVars); if (params.length === 0) { return of({ data: [] }); } if (this.isMetricTank) { params.push('meta=true'); } const httpOptions: BackendSrvRequest = { method: 'POST', url: '/render', data: params.join('&'), headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, }; this.addTracingHeaders(httpOptions, options); if (options.panelId) { httpOptions.requestId = this.name + '.panelId.' + options.panelId; } return this.doGraphiteRequest(httpOptions).pipe( map((result) => this.convertResponseToDataFrames(result, formattedRefIdsMap)) ); } backendBuildGraphiteQueries( options: DataQueryRequest<GraphiteQuery>, originalTargetMap: { [key: string]: string } ): GraphiteQuery[] { const referenceTargets: Record<string, string> = {}; const finalTargets: GraphiteQuery[] = []; let target: GraphiteQuery, targetValue, i; for (i = 0; i < options.targets.length; i++) { target = options.targets[i]; if (!target.target) { continue; } if (!target.refId) { target.refId = this._seriesRefLetters[i]; } referenceTargets[target.refId] = target.target; } const seriesReferenceRegex = /\#([A-Z])/g; function nestedSeriesRegexReplacer(match: string, g1: string) { // Handle the case where a query references itself to prevent infinite recursion if (target.refId === g1) { return referenceTargets[g1] || match; } // Recursively replace all nested series references return originalTargetMap[g1].replace(seriesReferenceRegex, nestedSeriesRegexReplacer) || match; } for (i = 0; i < options.targets.length; i++) { const targetClone = { ...options.targets[i] }; target = options.targets[i]; if (!targetClone.target) { continue; } targetValue = this.templateSrv.replace( referenceTargets[target.refId].replace(seriesReferenceRegex, nestedSeriesRegexReplacer), options.scopedVars ); targetClone.target = targetValue; if (this.isMetricTank) { targetClone.isMetricTank = true; } if (!targetClone.hide) { finalTargets.push(targetClone); } } return finalTargets; } query(options: DataQueryRequest<GraphiteQuery>): Observable<DataQueryResponse> { if (options.targets.some((target: GraphiteQuery) => target.fromAnnotations)) { const streams: Array<Observable<DataQueryResponse>> = []; for (const target of options.targets) { streams.push( new Observable((subscriber) => { this.annotationEvents(options.range, target) .then((events) => subscriber.next({ data: [toDataFrame(events)] })) .catch((ex) => subscriber.error(new Error(ex))) .finally(() => subscriber.complete()); }) ); } return merge(...streams); } // Use this object to map the sanitised refID to the original const formattedRefIdsMap: { [key: string]: string } = {}; // Use this object to map the original refID to the original target const originalTargetMap: { [key: string]: string } = {}; for (const target of options.targets) { // Sanitise the refID otherwise the Graphite query will fail const formattedRefId = target.refId.replaceAll(' ', '_'); formattedRefIdsMap[formattedRefId] = target.refId; // Track the original target to ensure if we need to interpolate a series, we interpolate using the original target // rather than the target wrapped in aliasSub e.g.: // Suppose a query has three targets: A: metric1 B: sumSeries(#A) and C: asPercent(#A, #B) // We want the targets to be interpolated to: A: aliasSub(metric1, "(^.*$)", "\\1 A"), B: aliasSub(sumSeries(metric1), "(^.*$)", "\\1 B") and C: asPercent(metric1, sumSeries(metric1)) originalTargetMap[target.refId] = target.target || ''; // We only need to alias queries in frontend mode if (!config.featureToggles.graphiteBackendMode) { // Use aliasSub to include the refID in the response series name. This allows us to set the refID on the frame. const updatedTarget = `aliasSub(${target.target}, "(^.*$)", "\\1 ${formattedRefId}")`; target.target = updatedTarget; } } if (config.featureToggles.graphiteBackendMode) { const graphiteQueries = this.backendBuildGraphiteQueries(options, originalTargetMap); options.targets = graphiteQueries; return super.query(options); } return this.frontendQuery(options, originalTargetMap, formattedRefIdsMap); } addTracingHeaders(httpOptions: BackendSrvRequest, options: Partial<DataQueryRequest<GraphiteQuery>>) { const proxyMode = !this.url?.match(/^http/); if (!httpOptions.headers) { httpOptions.headers = {}; } if (proxyMode) { if (options.dashboardUID) { httpOptions.headers['X-Dashboard-Id'] = options.dashboardUID; } if (options.panelId) { httpOptions.headers['X-Panel-Id'] = options.panelId; } if (options.panelPluginId) { httpOptions.headers['X-Panel-Plugin-Id'] = options.panelPluginId; } } } convertResponseToDataFrames = (result: FetchResponse, refIdMap: { [key: string]: string }): DataQueryResponse => { const data: DataFrame[] = []; if (!result || !result.data) { return { data }; } // Series are either at the root or under a node called 'series' const series: Array<{ target: string; title: string; tags: Record<string, string | number>; datapoints: Array<[number, number]>; meta: MetricTankSeriesMeta[]; }> = result.data.series || result.data; if (!isArray(series)) { throw { message: 'Missing series in result', data: result }; } for (let i = 0; i < series.length; i++) { const s = series[i]; let refId = ''; // Retrieve the original refID of the query const splitTarget = s.target.split(' '); if (splitTarget.length > 1) { // refID should always be the last element refId = splitTarget.pop() || ''; s.target = splitTarget.join(' '); } // Disables Grafana own series naming s.title = s.target; for (let y = 0; y < s.datapoints.length; y++) { s.datapoints[y][1] *= 1000; } const frame = toDataFrame(s); // Set the refID value on the frame frame.refId = refIdMap[refId]; // Metrictank metadata if (s.meta) { frame.meta = { custom: { requestMetaList: result.data.meta, // info for the whole request seriesMetaList: s.meta, // Array of metadata }, }; if (this.rollupIndicatorEnabled) { const rollupNotice = getRollupNotice(s.meta); const runtimeNotice = getRuntimeConsolidationNotice(s.meta); if (rollupNotice) { frame.meta.notices = [rollupNotice]; } else if (runtimeNotice) { frame.meta.notices = [runtimeNotice]; } } // only add the request stats to the first frame if (i === 0 && result.data.meta.stats) { frame.meta.stats = this.getRequestStats(result.data.meta); } } data.push(frame); } return { data }; }; getRequestStats(meta: MetricTankRequestMeta): QueryResultMetaStat[] { const stats: QueryResultMetaStat[] = []; for (const key in meta.stats) { let unit: string | undefined = undefined; if (key.endsWith('.ms')) { unit = 'ms'; } stats.push({ displayName: key, value: meta.stats[key], unit }); } return stats; } parseTags(tagString: string) { let tags: string[] = []; tags = tagString.split(','); if (tags.length === 1) { tags = tagString.split(' '); if (tags[0] === '') { tags = []; } } return tags; } interpolateVariablesInQueries(queries: GraphiteQuery[], scopedVars: ScopedVars): GraphiteQuery[] { let expandedQueries = queries; if (queries && queries.length > 0) { expandedQueries = queries.map((query) => { const expandedQuery = { ...query, datasource: this.getRef(), target: this.templateSrv.replace(query.target ?? '', scopedVars), }; return expandedQuery; }); } return expandedQueries; } annotationEvents(range: TimeRange, target: GraphiteQuery) { if (target.target) { // Graphite query as target as annotation const targetAnnotation = this.templateSrv.replace(target.target, {}, 'glob'); const graphiteQuery = { range: range, targets: [{ target: targetAnnotation, refId: target.refId }], format: 'json', maxDataPoints: 100, } as unknown as DataQueryRequest<GraphiteQuery>; return lastValueFrom( this.query(graphiteQuery).pipe( map((result) => { const list = []; for (let i = 0; i < result.data.length; i++) { const target = result.data[i]; for (let y = 0; y < target.length; y++) { const time = target.fields[0].values[y]; const value = target.fields[1].values[y]; if (!value) { continue; } list.push({ annotation: target, time, title: target.name, }); } } return list; }) ) ); } else { // Graphite event/tag as annotation const tags = this.templateSrv.replace(target.tags?.join(' ')); return this.events({ range: range, tags: tags }).then((results) => { const list = []; if (!isArray(results.data)) { console.error(`Unable to get annotations.`); return []; } for (let i = 0; i < results.data.length; i++) { const e = results.data[i]; let tags = e.tags; if (isString(e.tags)) { tags = this.parseTags(e.tags); } list.push({ annotation: target, time: e.when * 1000, title: e.what, tags: tags, text: e.data, }); } return list; }); } } async events(options: { range: TimeRange; tags: string; timezone?: TimeZone; }): Promise<{ data: GraphiteEvents[] } | FetchResponse<GraphiteEvents>> { try { const tags = options.tags || ''; const from = this.translateTime(options.range.raw.from, false, options.timezone); const until = this.translateTime(options.range.raw.to, true, options.timezone); if (config.featureToggles.graphiteBackendMode) { return await this.postResource<{ data: GraphiteEvents[] }>('events', { from: typeof from === 'string' ? from : `${from}`, until: typeof until === 'string' ? until : `${until}`, tags, }); } else { const tagsQueryParam = tags === '' ? '' : `&tags=${tags}`; return lastValueFrom( this.doGraphiteRequest<GraphiteEvents[]>({ method: 'GET', url: `/events/get_data?from=${from}&until=${until}${tagsQueryParam}`, }) ); } } catch (err) { return Promise.reject(err); } } targetContainsTemplate(target: GraphiteQuery) { return this.templateSrv.containsTemplate(target.target ?? ''); } translateTime(date: DateTime | string, roundUp?: boolean, timezone?: TimeZone) { const parseDate = () => { if (isString(date)) { if (date === 'now') { return 'now'; } else if (date.indexOf('now-') >= 0 && date.indexOf('/') === -1) { return date.substring(3).replace('m', 'min').replace('M', 'mon'); } const parsedDate = dateMath.toDateTime(date, { roundUp, timezone }); // If the date is invalid return the original string // e.g. if an empty string is passed in or if the roundng is invalid e.g. now/2y if (!parsedDate || parsedDate.isValid() === false) { return date; } return moment(parsedDate.toDate()); } else { return moment(date.toDate()); } }; const parsedDate = parseDate(); if (typeof parsedDate === 'string') { return parsedDate; } // graphite' s from filter is exclusive // here we step back one minute in order // to guarantee that we get all the data that // exists for the specified range if (roundUp) { if (parsedDate.get('s')) { parsedDate.add(1, 's'); } } else if (roundUp === false) { if (parsedDate.get('s')) { parsedDate.subtract(1, 's'); } } return parsedDate.unix(); } metricFindQuery(findQuery: string | GraphiteQuery, optionalOptions?: any): Promise<MetricFindValue[]> { const options = optionalOptions || {}; const queryObject = convertToGraphiteQueryObject(findQuery); if (queryObject.queryType === GraphiteQueryType.Value || queryObject.queryType === GraphiteQueryType.MetricName) { return this.requestMetricRender(queryObject, options, queryObject.queryType); } let query = queryObject.target ?? ''; // First attempt to check for tag-related functions (using empty wildcard for interpolation) let interpolatedQuery = this.templateSrv.replace( query, getSearchFilterScopedVar({ query, wildcardChar: '', options: optionalOptions }) ); // special handling for tag_values(<tag>[,<expression>]*), this is used for template variables let allParams = interpolatedQuery.match(/^tag_values\((.*)\)$/); let expressions = allParams ? allParams[1].split(/,(?![^{]*\})/).filter((p) => !!p) : undefined; if (expressions) { options.limit = 10000; return this.getTagValuesAutoComplete(expressions.slice(1), expressions[0], undefined, options); } // special handling for tags(<expression>[,<expression>]*), this is used for template variables allParams = interpolatedQuery.match(/^tags\((.*)\)$/); expressions = allParams ? allParams[1].split(',').filter((p) => !!p) : undefined; if (expressions) { options.limit = 10000; return this.getTagsAutoComplete(expressions, undefined, options); } // If no tag-related query was found, perform metric-based search (using * as the wildcard for interpolation) let useExpand = query.match(/^expand\((.*)\)$/); query = useExpand ? useExpand[1] : query; interpolatedQuery = this.templateSrv.replace( query, getSearchFilterScopedVar({ query, wildcardChar: '*', options: optionalOptions }) ); let range; if (options.range) { range = { from: this.translateTime(options.range.from, false, options.timezone), until: this.translateTime(options.range.to, true, options.timezone), }; } if (useExpand) { return this.requestMetricExpand(interpolatedQuery, options.requestId, range); } else { return this.requestMetricFind(interpolatedQuery, options.requestId, range); } } /** * Search for metrics matching giving pattern using /metrics/render endpoint. * It will return all possible values or names and parse them based on queryType. * For example: * * queryType: GraphiteQueryType.Value * query: groupByNode(movingAverage(apps.country.IE.counters.requests.count, 10), 2, 'sum') * result: 239.4, 233.4, 230.8, 230.4, 233.9, 238, 239.8, 236.8, 235.8 * * queryType: GraphiteQueryType.MetricName * query: highestAverage(carbon.agents.*.*, 5) * result: carbon.agents.aa6338c54341-a.memUsage, carbon.agents.aa6338c54341-a.committedPoints, carbon.agents.aa6338c54341-a.updateOperations, carbon.agents.aa6338c54341-a.metricsReceived, carbon.agents.aa6338c54341-a.activeConnections */ private async requestMetricRender( queryObject: GraphiteQuery, options: any, queryType: GraphiteQueryType ): Promise<MetricFindValue[]> { const requestId: string = options.requestId ?? `Q${this.requestCounter++}`; const range: TimeRange = options.range ?? { from: dateTime().subtract(6, 'hour'), to: dateTime(), raw: { from: 'now - 6h', to: 'now', }, }; const queryReq: DataQueryRequest<GraphiteQuery> = { app: 'graphite-variable-editor', interval: '1s', intervalMs: 10000, startTime: Date.now(), targets: [{ ...queryObject }], timezone: 'browser', scopedVars: {}, requestId, range, }; const data: DataQueryResponse = await lastValueFrom(this.query(queryReq)); let result: MetricFindValue[]; if (queryType === GraphiteQueryType.Value) { if (!data.data || data.data.length === 0) { return Promise.resolve([]); } result = data.data[0].fields[1].values .filter((f?: number) => !!f) .map((v: number) => ({ text: v.toString(), value: v, expandable: false, })); } else if (queryType === GraphiteQueryType.MetricName) { result = data.data.map((series) => ({ text: series.name, value: series.name, expandable: false, })); } else { result = []; } return Promise.resolve(result); } /** * Search for metrics matching giving pattern using /metrics/find endpoint. It will * return all possible values at the last level of the query, for example: * * metrics: prod.servers.001.cpu, prod.servers.002.cpu * query: *.servers.* * result: 001, 002 * * For more complex searches use requestMetricExpand */ private async requestMetricFind( query: string, requestId: string, range?: { from: string | number; until: string | number } ): Promise<MetricFindValue[]> { const params: BackendSrvRequest['params'] = {}; if (range) { params.from = range.from; params.until = range.until; } if (config.featureToggles.graphiteBackendMode) { return await this.postResource<MetricFindValue[]>('metrics/find', { from: params.from ? (typeof params.from === 'string' ? params.from : `${params.from}`) : undefined, until: params.until ? (typeof params.until === 'string' ? params.until : `${params.until}`) : undefined, query, }); } const httpOptions: BackendSrvRequest = { method: 'POST', url: '/metrics/find', params, data: `query=${query}`, headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, // for cancellations requestId: requestId, }; return lastValueFrom( this.doGraphiteRequest(httpOptions).pipe( map((results: FetchResponse) => { return _map(results.data, (metric) => { return { text: metric.text, expandable: metric.expandable ? true : false, }; }); }) ) ); } /** * Search for metrics matching giving pattern using /metrics/expand endpoint. * The result will contain all metrics (with full name) matching provided query. * It's a more flexible version of /metrics/find endpoint (@see requestMetricFind) */ private async requestMetricExpand( query: string, requestId: string, range?: { from: string | number; until: string | number } ): Promise<MetricFindValue[]> { const params: BackendSrvRequest['params'] = { query }; if (range) { params.from = range.from; params.until = range.until; } if (config.featureToggles.graphiteBackendMode) { const metrics = await this.postResource<MetricFindValue[]>('metrics/expand', { from: params.from ? (typeof params.from === 'string' ? params.from : `${params.from}`) : undefined, until: params.until ? (typeof params.until === 'string' ? params.until : `${params.until}`) : undefined, query, }); return metrics.map((metric) => ({ text: metric.text, expandable: false, })); } const httpOptions: BackendSrvRequest = { method: 'GET', url: '/metrics/expand', params, headers: { 'Content-Type': 'application/x-www-form-urlencoded', }, // for cancellations requestId, }; return lastValueFrom( this.doGraphiteRequest(httpOptions).pipe( map((results: FetchResponse) => { return _map(results.data.results, (metric) => { return { text: metric, expandable: false, }; }); }) ) ); } async getTagsAutoComplete(expressions: string[], tagPrefix?: string, optionalOptions?: any) { const options = optionalOptions || {}; const params: BackendSrvRequest['params'] = { expr: _map(expressions, (expression) => this.templateSrv.replace((expression || '').trim())), }; if (tagPrefix) { params.tagPrefix = tagPrefix; } if (options.limit) { params.limit = options.limit; } if (options.range) { params.from = this.translateTime(options.range.from, false, options.timezone); params.until = this.translateTime(options.range.to, true, options.timezone); } if (config.featureToggles.graphiteBackendMode) { const tags = await this.postResource<string[]>('tags/autoComplete/tags', { from: typeof params.from === 'string' ? params.from : `${params.from}`, until: typeof params.until === 'string' ? params.until : `${params.until}`, tagPrefix, limit: options.limit, }); return tags.map((tag) => ({ text: tag, })); } const httpOptions: BackendSrvRequest = { method: 'GET', url: '/tags/autoComplete/tags', params, // for cancellations requestId: options.requestId, }; return lastValueFrom(this.doGraphiteRequest(httpOptions).pipe(mapToTags())); } async getTagValuesAutoComplete(expressions: string[], tag: string, valuePrefix?: string, optionalOptions?: any) { const options = optionalOptions || {}; const params: BackendSrvRequest['params'] = { expr: _map(expressions, (expression) => this.templateSrv.replace((expression || '').trim())), tag: this.templateSrv.replace((tag || '').trim()), }; if (valuePrefix) { params.valuePrefix = valuePrefix; } if (options.limit) { params.limit = options.limit; } if (options.range) { params.from = this.translateTime(options.range.from, false, options.timezone); params.until = this.translateTime(options.range.to, true, options.timezone); } if (config.featureToggles.graphiteBackendMode) { const tagValues = await this.postResource<string[]>('tags/autoComplete/values', { from: typeof params.from === 'string' ? params.from : `${params.from}`, until: typeof params.until === 'string' ? params.until : `${params.until}`, expr: params.expr, tag: params.tag, valuePrefix, limit: options.limit, }); return tagValues.map((tag) => ({ text: tag, })); } const httpOptions: BackendSrvRequest = { method: 'GET', url: '/tags/autoComplete/values', params, // for cancellations requestId: options.requestId, }; return lastValueFrom(this.doGraphiteRequest(httpOptions).pipe(mapToTags())); } async getVersion(optionalOptions: any) { const options = optionalOptions || {}; const httpOptions = { method: 'GET', url: '/version', requestId: options.requestId, }; if (config.featureToggles.graphiteBackendMode) { const version = await this.getResource<string>('version'); const semver = new SemVer(version); return valid(semver) ? version : ''; } return lastValueFrom( this.doGraphiteRequest(httpOptions).pipe( map((results: FetchResponse) => { if (results.data) { const semver = new SemVer(results.data); return valid(semver) ? results.data : ''; } return ''; }), catchError(() => { return of(''); }) ) ); } createFuncInstance(funcDef: string | FuncDef, options?: { withDefaultParams: boolean }): FuncInstance { return gfunc.createFuncInstance(funcDef, options, this.funcDefs); } getFuncDef(name: string) { return gfunc.getFuncDef(name, this.funcDefs); } waitForFuncDefsLoaded() { return this.getFuncDefs(); } async getFuncDefs() { if (this.funcDefsPromise !== null) { return this.funcDefsPromise; } if (!supportsFunctionIndex(this.graphiteVersion)) { this.funcDefs = gfunc.getFuncDefs(this.graphiteVersion); this.funcDefsPromise = Promise.resolve(this.funcDefs); return this.funcDefsPromise; } const httpOptions = { method: 'GET', url: '/functions', // add responseType because if this is not defined, // backend_srv defaults to json responseType: 'text' as const, }; if (config.featureToggles.graphiteBackendMode) { try { const functions = await this.getResource<string>('functions'); this.funcDefs = gfunc.parseFuncDefs(functions); return this.funcDefs; } catch (error) { console.error('Fetching graphite functions error', error); this.funcDefs = gfunc.getFuncDefs(this.graphiteVersion); return this.funcDefs; } } return lastValueFrom( this.doGraphiteRequest(httpOptions).pipe( map((results: FetchResponse) => { // Fix for a Graphite bug: https://github.com/graphite-project/graphite-web/issues/2609 // There is a fix for it https://github.com/graphite-project/graphite-web/pull/2612 but // it was merged to master in July 2020 but it has never been released (the last Graphite // release was 1.1.7 - March 2020). The bug was introduced in Graphite 1.1.7, in versions // 1.1.0 - 1.1.6 /functions endpoint returns a valid JSON const fixedData = JSON.parse(results.data.replace(/"default": ?Infinity/g, '"default": 1e9999')); this.funcDefs = gfunc.parseFuncDefs(fixedData); return this.funcDefs; }), catchError((error) => { console.error('Fetching graphite functions error', error); this.funcDefs = gfunc.getFuncDefs(this.graphiteVersion); return of(this.funcDefs); }) ) ); } testDatasource() { if (config.featureToggles.graphiteBackendMode) { return super.testDatasource(); } const query: DataQueryRequest<GraphiteQuery> = { app: 'graphite', interval: '10ms', intervalMs: 10, requestId: 'reqId', scopedVars: {}, startTime: 0, timezone: 'browser', panelId: 3, rangeRaw: { from: 'now-1h', to: 'now' }, range: { from: dateTime('now-1h'), to: dateTime('now'), raw: { from: 'now-1h', to: 'now' }, }, targets: [{ refId: 'A', target: 'constantLine(100)' }], maxDataPoints: 300, }; return lastValueFrom(this.query(query)).then(() => ({ status: 'success', message: 'Data source is working' })); } doGraphiteRequest<T>( options: BackendSrvRequest & { inspect?: any; } ) { if (this.basicAuth || this.withCredentials) { options.withCredentials = true; } if (this.basicAuth) { options.headers = options.headers || {}; options.headers.Authorization = this.basicAuth; } options.url = this.url + options.url; options.inspect = { type: 'graphite' }; return getBackendSrv() .fetch<T>(options) .pipe( catchError((err) => { return throwError(() => { const reduced = reduceError(err); return new Error(`${reduced.data.message}`); }); }) ); } // Can be removed when the frontend query path is removed buildGraphiteParams(options: any, originalTargetMap: { [key: string]: string }, scopedVars?: ScopedVars): string[] { const graphiteOptions = ['from', 'until', 'rawData', 'format', 'maxDataPoints', 'cacheTimeout']; const cleanOptions = [], targets: Record<string, string> = {}; let target: GraphiteQuery, targetValue, i; const intervalFormatFixRegex = /'(\d+)m'/gi; let hasTargets = false; options['format'] = 'json'; function fixIntervalFormat(match: string) { return match.replace('m', 'min').replace('M', 'mon'); } for (i = 0; i < options.targets.length; i++) { target = options.targets[i]; if (!target.target) { continue; } if (!target.refId) { target.refId = this._seriesRefLetters[i]; } targetValue = this.templateSrv.replace(target.target, scopedVars); targetValue = targetValue.replace(intervalFormatFixRegex, fixIntervalFormat); targets[target.refId] = targetValue; } const regex = /\#([A-Z])/g; function nestedSeriesRegexReplacer(match: string, g1: string) { // Handle the case where a query references itself to prevent infinite recursion if (target.refId === g1) { return targets[g1] || match; } // Recursively replace all nested series references return originalTargetMap[g1].replace(regex, nestedSeriesRegexReplacer) || match; } for (i = 0; i < options.targets.length; i++) { target = options.targets[i]; if (!target.target) { continue; } targetValue = targets[target.refId]; targetValue = this.templateSrv.replace(targetValue.replace(regex, nestedSeriesRegexReplacer), scopedVars); targets[target.refId] = targetValue; if (!target.hide) { hasTargets = true; cleanOptions.push('target=' + encodeURIComponent(targetValue)); } } each(options, (value, key) => { if (indexOf(graphiteOptions, key) === -1) { return; } if (value) { cleanOptions.push(key + '=' + encodeURIComponent(value)); } }); if (!hasTargets) { return []; } return cleanOptions; } } function supportsTags(version: string): boolean { const fullVersion = coerce(version); if (!fullVersion) { return false; } return gte(fullVersion, '1.1.0'); } function supportsFunctionIndex(version: string): boolean { const fullVersion = coerce(version); if (!fullVersion) { return false; } return gte(fullVersion, '1.1.0'); } function mapToTags(): OperatorFunction<FetchResponse, Array<{ text: string }>> { return pipe( map((results) => { if (results.data) { return _map(results.data, (value) => { return { text: value }; }); } else { return []; } }) ); }
.
Edit
..
Edit
CHANGELOG.md
Edit
README.md
Edit
components
Edit
configuration
Edit
dashboards
Edit
datasource.test.ts
Edit
datasource.ts
Edit
datasource_integration.test.ts
Edit
dist
Edit
gfunc.test.ts
Edit
gfunc.ts
Edit
graphite_query.ts
Edit
img
Edit
jest-setup.js
Edit
jest.config.js
Edit
lexer.ts
Edit
meta.test.ts
Edit
meta.ts
Edit
migrations.ts
Edit
module.ts
Edit
package.json
Edit
parser.ts
Edit
plugin.json
Edit
project.json
Edit
query_help.md
Edit
specs
Edit
state
Edit
tsconfig.json
Edit
types.ts
Edit
utils.test.ts
Edit
utils.ts
Edit
versions.ts
Edit
webpack.config.ts
Edit