ace: working on editor completion stuff

This commit is contained in:
Torkel Ödegaard
2017-08-10 09:33:17 +02:00
parent b9540e4c49
commit 0b2cc404ff
5 changed files with 136 additions and 102 deletions

View File

@@ -37,7 +37,7 @@ const GRAFANA_MODULES = ['mode-prometheus', 'snippets-prometheus', 'theme-grafan
const GRAFANA_MODULE_BASE = "public/app/core/components/code_editor/"; const GRAFANA_MODULE_BASE = "public/app/core/components/code_editor/";
// Trick for loading additional modules // Trick for loading additional modules
function fixModuleUrl(moduleType, name) { function setModuleUrl(moduleType, name) {
let baseUrl = ACE_SRC_BASE; let baseUrl = ACE_SRC_BASE;
let aceModeName = `ace/${moduleType}/${name}`; let aceModeName = `ace/${moduleType}/${name}`;
let moduleName = `${moduleType}-${name}`; let moduleName = `${moduleType}-${name}`;
@@ -54,7 +54,7 @@ function fixModuleUrl(moduleType, name) {
ace.config.setModuleUrl(aceModeName, baseUrl + componentName); ace.config.setModuleUrl(aceModeName, baseUrl + componentName);
} }
fixModuleUrl("ext", "language_tools"); setModuleUrl("ext", "language_tools");
let editorTemplate = `<div></div>`; let editorTemplate = `<div></div>`;
@@ -129,38 +129,42 @@ function link(scope, elem, attrs) {
}); });
let extCompleter = { let extCompleter = {
getCompletions: getCompletions identifierRegexps: [/[\[\]a-zA-Z_0-9=]/],
getCompletions: function (editor, session, pos, prefix, callback) {
console.log(pos);
scope.getCompletions({$query: prefix}).then(results => {
callback(null, results.map(hit => {
return {
caption: hit.word,
value: hit.word,
meta: hit.type
};
}));
});
},
}; };
function getCompletions(editor, session, pos, prefix, callback) {
scope.getCompletions({$query: prefix}).then(results => {
callback(null, results.map(hit => {
return {
caption: hit.word,
value: hit.word,
meta: hit.type
};
}));
});
}
function setLangMode(lang) { function setLangMode(lang) {
let aceModeName = `ace/mode/${lang}`; let aceModeName = `ace/mode/${lang}`;
fixModuleUrl("mode", lang); setModuleUrl("mode", lang);
fixModuleUrl("snippets", lang); setModuleUrl("snippets", lang);
editorSession.setMode(aceModeName); editorSession.setMode(aceModeName);
ace.config.loadModule("ace/ext/language_tools", (language_tools) => { ace.config.loadModule("ace/ext/language_tools", (language_tools) => {
codeEditor.setOptions({ codeEditor.setOptions({
enableBasicAutocompletion: true, enableBasicAutocompletion: true,
enableLiveAutocompletion: true, enableLiveAutocompletion: true,
enableSnippets: true enableSnippets: true
}); });
codeEditor.completers.push(extCompleter);
if (scope.getCompleter) {
codeEditor.completers.push(scope.getCompleter());
}
}); });
} }
function setThemeMode(theme) { function setThemeMode(theme) {
fixModuleUrl("theme", theme); setModuleUrl("theme", theme);
codeEditor.setTheme(`ace/theme/${theme}`); codeEditor.setTheme(`ace/theme/${theme}`);
} }
@@ -177,7 +181,7 @@ export function codeEditorDirective() {
scope: { scope: {
content: "=", content: "=",
onChange: "&", onChange: "&",
getCompletions: "&" getCompleter: "&"
}, },
link: link link: link
}; };

View File

@@ -0,0 +1,24 @@
///<reference path="../../../headers/common.d.ts" />
import {PrometheusDatasource} from "./datasource";
export class PromCompleter {
identifierRegexps = [/[\[\]a-zA-Z_0-9=]/];
constructor(private datasource: PrometheusDatasource) {
}
getCompletions(editor, session, pos, prefix, callback) {
var query = prefix;
return this.datasource.performSuggestQuery(query).then(metricNames => {
callback(null, metricNames.map(name => {
return {
caption: name,
value: name,
meta: 'metric',
};
}));
});
}
}

View File

@@ -11,18 +11,37 @@ import TableModel from 'app/core/table_model';
var durationSplitRegexp = /(\d+)(ms|s|m|h|d|w|M|y)/; var durationSplitRegexp = /(\d+)(ms|s|m|h|d|w|M|y)/;
/** @ngInject */ function prometheusSpecialRegexEscape(value) {
export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateSrv, timeSrv) { return value.replace(/[\\^$*+?.()|[\]{}]/g, '\\\\$&');
this.type = 'prometheus'; }
this.editorSrc = 'app/features/prometheus/partials/query.editor.html';
this.name = instanceSettings.name;
this.supportMetrics = true;
this.url = instanceSettings.url;
this.directUrl = instanceSettings.directUrl;
this.basicAuth = instanceSettings.basicAuth;
this.withCredentials = instanceSettings.withCredentials;
this._request = function(method, url, requestId) { export class PrometheusDatasource {
type: string;
editorSrc: string;
name: string;
supportMetrics: boolean;
url: string;
directUrl: string;
basicAuth: any;
withCredentials: any;
/** @ngInject */
constructor(instanceSettings,
private $q,
private backendSrv,
private templateSrv,
private timeSrv) {
this.type = 'prometheus';
this.editorSrc = 'app/features/prometheus/partials/query.editor.html';
this.name = instanceSettings.name;
this.supportMetrics = true;
this.url = instanceSettings.url;
this.directUrl = instanceSettings.directUrl;
this.basicAuth = instanceSettings.basicAuth;
this.withCredentials = instanceSettings.withCredentials;
}
_request(method, url, requestId?) {
var options: any = { var options: any = {
url: this.url + url, url: this.url + url,
method: method, method: method,
@@ -32,20 +51,17 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
if (this.basicAuth || this.withCredentials) { if (this.basicAuth || this.withCredentials) {
options.withCredentials = true; options.withCredentials = true;
} }
if (this.basicAuth) { if (this.basicAuth) {
options.headers = { options.headers = {
"Authorization": this.basicAuth "Authorization": this.basicAuth
}; };
} }
return backendSrv.datasourceRequest(options); return this.backendSrv.datasourceRequest(options);
};
function prometheusSpecialRegexEscape(value) {
return value.replace(/[\\^$*+?.()|[\]{}]/g, '\\\\$&');
} }
this.interpolateQueryExpr = function(value, variable, defaultFormatFn) { interpolateQueryExpr(value, variable, defaultFormatFn) {
// if no multi or include all do not regexEscape // if no multi or include all do not regexEscape
if (!variable.multi && !variable.includeAll) { if (!variable.multi && !variable.includeAll) {
return value; return value;
@@ -57,14 +73,13 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
var escapedValues = _.map(value, prometheusSpecialRegexEscape); var escapedValues = _.map(value, prometheusSpecialRegexEscape);
return escapedValues.join('|'); return escapedValues.join('|');
}; }
this.targetContainsTemplate = function(target) { targetContainsTemplate(target) {
return templateSrv.variableExists(target.expr); return this.templateSrv.variableExists(target.expr);
}; }
// Called once per panel (graph) query(options) {
this.query = function(options) {
var self = this; var self = this;
var start = this.getPrometheusTime(options.range.from, false); var start = this.getPrometheusTime(options.range.from, false);
var end = this.getPrometheusTime(options.range.to, true); var end = this.getPrometheusTime(options.range.to, true);
@@ -82,10 +97,10 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
activeTargets.push(target); activeTargets.push(target);
var query: any = {}; var query: any = {};
query.expr = templateSrv.replace(target.expr, options.scopedVars, self.interpolateQueryExpr); query.expr = this.templateSrv.replace(target.expr, options.scopedVars, self.interpolateQueryExpr);
query.requestId = options.panelId + target.refId; query.requestId = options.panelId + target.refId;
var interval = templateSrv.replace(target.interval, options.scopedVars) || options.interval; var interval = this.templateSrv.replace(target.interval, options.scopedVars) || options.interval;
var intervalFactor = target.intervalFactor || 1; var intervalFactor = target.intervalFactor || 1;
target.step = query.step = this.calculateInterval(interval, intervalFactor); target.step = query.step = this.calculateInterval(interval, intervalFactor);
var range = Math.ceil(end - start); var range = Math.ceil(end - start);
@@ -95,14 +110,14 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
// No valid targets, return the empty result to save a round trip. // No valid targets, return the empty result to save a round trip.
if (_.isEmpty(queries)) { if (_.isEmpty(queries)) {
return $q.when({ data: [] }); return this.$q.when({ data: [] });
} }
var allQueryPromise = _.map(queries, query => { var allQueryPromise = _.map(queries, query => {
return this.performTimeSeriesQuery(query, start, end); return this.performTimeSeriesQuery(query, start, end);
}); });
return $q.all(allQueryPromise).then(responseList => { return this.$q.all(allQueryPromise).then(responseList => {
var result = []; var result = [];
var index = 0; var index = 0;
@@ -122,27 +137,27 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
return { data: result }; return { data: result };
}); });
}; }
this.adjustStep = function(step, autoStep, range) { adjustStep(step, autoStep, range) {
// Prometheus drop query if range/step > 11000 // Prometheus drop query if range/step > 11000
// calibrate step if it is too big // calibrate step if it is too big
if (step !== 0 && range / step > 11000) { if (step !== 0 && range / step > 11000) {
return Math.ceil(range / 11000); return Math.ceil(range / 11000);
} }
return Math.max(step, autoStep); return Math.max(step, autoStep);
}; }
this.performTimeSeriesQuery = function(query, start, end) { performTimeSeriesQuery(query, start, end) {
if (start > end) { if (start > end) {
throw { message: 'Invalid time range' }; throw { message: 'Invalid time range' };
} }
var url = '/api/v1/query_range?query=' + encodeURIComponent(query.expr) + '&start=' + start + '&end=' + end + '&step=' + query.step; var url = '/api/v1/query_range?query=' + encodeURIComponent(query.expr) + '&start=' + start + '&end=' + end + '&step=' + query.step;
return this._request('GET', url, query.requestId); return this._request('GET', url, query.requestId);
}; }
this.performSuggestQuery = function(query) { performSuggestQuery(query) {
var url = '/api/v1/label/__name__/values'; var url = '/api/v1/label/__name__/values';
return this._request('GET', url).then(function(result) { return this._request('GET', url).then(function(result) {
@@ -150,41 +165,30 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
return metricName.indexOf(query) !== 1; return metricName.indexOf(query) !== 1;
}); });
}); });
}; }
this.metricFindQuery = function(query) { metricFindQuery(query) {
if (!query) { return $q.when([]); } if (!query) { return this.$q.when([]); }
var interpolated; let interpolated = this.templateSrv.replace(query, {}, this.interpolateQueryExpr);
try { var metricFindQuery = new PrometheusMetricFindQuery(this, interpolated, this.timeSrv);
interpolated = templateSrv.replace(query, {}, this.interpolateQueryExpr);
} catch (err) {
return $q.reject(err);
}
var metricFindQuery = new PrometheusMetricFindQuery(this, interpolated, timeSrv);
return metricFindQuery.process(); return metricFindQuery.process();
}; }
this.annotationQuery = function(options) { annotationQuery(options) {
var annotation = options.annotation; var annotation = options.annotation;
var expr = annotation.expr || ''; var expr = annotation.expr || '';
var tagKeys = annotation.tagKeys || ''; var tagKeys = annotation.tagKeys || '';
var titleFormat = annotation.titleFormat || ''; var titleFormat = annotation.titleFormat || '';
var textFormat = annotation.textFormat || ''; var textFormat = annotation.textFormat || '';
if (!expr) { return $q.when([]); } if (!expr) { return this.$q.when([]); }
var interpolated; var interpolated = this.templateSrv.replace(expr, {}, this.interpolateQueryExpr);
try {
interpolated = templateSrv.replace(expr, {}, this.interpolateQueryExpr);
} catch (err) {
return $q.reject(err);
}
var step = '60s'; var step = '60s';
if (annotation.step) { if (annotation.step) {
step = templateSrv.replace(annotation.step); step = this.templateSrv.replace(annotation.step);
} }
var start = this.getPrometheusTime(options.range.from, false); var start = this.getPrometheusTime(options.range.from, false);
@@ -222,19 +226,19 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
return eventList; return eventList;
}); });
}; }
this.testDatasource = function() { testDatasource() {
return this.metricFindQuery('metrics(.*)').then(function() { return this.metricFindQuery('metrics(.*)').then(function() {
return { status: 'success', message: 'Data source is working', title: 'Success' }; return { status: 'success', message: 'Data source is working', title: 'Success' };
}); });
}; }
this.calculateInterval = function(interval, intervalFactor) { calculateInterval(interval, intervalFactor) {
return Math.ceil(this.intervalSeconds(interval) * intervalFactor); return Math.ceil(this.intervalSeconds(interval) * intervalFactor);
}; }
this.intervalSeconds = function(interval) { intervalSeconds(interval) {
var m = interval.match(durationSplitRegexp); var m = interval.match(durationSplitRegexp);
var dur = moment.duration(parseInt(m[1]), m[2]); var dur = moment.duration(parseInt(m[1]), m[2]);
var sec = dur.asSeconds(); var sec = dur.asSeconds();
@@ -243,9 +247,9 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
} }
return sec; return sec;
}; }
this.transformMetricData = function(md, options, start, end) { transformMetricData(md, options, start, end) {
var dps = [], var dps = [],
metricLabel = null; metricLabel = null;
@@ -273,9 +277,9 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
} }
return { target: metricLabel, datapoints: dps }; return { target: metricLabel, datapoints: dps };
}; }
this.transformMetricDataToTable = function(md) { transformMetricDataToTable(md) {
var table = new TableModel(); var table = new TableModel();
var i, j; var i, j;
var metricLabels = {}; var metricLabels = {};
@@ -325,17 +329,17 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
}); });
return table; return table;
}; }
this.createMetricLabel = function(labelData, options) { createMetricLabel(labelData, options) {
if (_.isUndefined(options) || _.isEmpty(options.legendFormat)) { if (_.isUndefined(options) || _.isEmpty(options.legendFormat)) {
return this.getOriginalMetricName(labelData); return this.getOriginalMetricName(labelData);
} }
return this.renderTemplate(templateSrv.replace(options.legendFormat), labelData) || '{}'; return this.renderTemplate(this.templateSrv.replace(options.legendFormat), labelData) || '{}';
}; }
this.renderTemplate = function(aliasPattern, aliasData) { renderTemplate(aliasPattern, aliasData) {
var aliasRegex = /\{\{\s*(.+?)\s*\}\}/g; var aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
return aliasPattern.replace(aliasRegex, function(match, g1) { return aliasPattern.replace(aliasRegex, function(match, g1) {
if (aliasData[g1]) { if (aliasData[g1]) {
@@ -343,21 +347,21 @@ export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateS
} }
return g1; return g1;
}); });
}; }
this.getOriginalMetricName = function(labelData) { getOriginalMetricName(labelData) {
var metricName = labelData.__name__ || ''; var metricName = labelData.__name__ || '';
delete labelData.__name__; delete labelData.__name__;
var labelPart = _.map(_.toPairs(labelData), function(label) { var labelPart = _.map(_.toPairs(labelData), function(label) {
return label[0] + '="' + label[1] + '"'; return label[0] + '="' + label[1] + '"';
}).join(','); }).join(',');
return metricName + '{' + labelPart + '}'; return metricName + '{' + labelPart + '}';
}; }
this.getPrometheusTime = function(date, roundUp) { getPrometheusTime(date, roundUp) {
if (_.isString(date)) { if (_.isString(date)) {
date = dateMath.parse(date, roundUp); date = dateMath.parse(date, roundUp);
} }
return Math.ceil(date.valueOf() / 1000); return Math.ceil(date.valueOf() / 1000);
}; }
} }

View File

@@ -2,7 +2,7 @@
<div class="gf-form-inline"> <div class="gf-form-inline">
<div class="gf-form gf-form--grow"> <div class="gf-form gf-form--grow">
<code-editor content="ctrl.target.expr" on-change="ctrl.refreshMetricData()" <code-editor content="ctrl.target.expr" on-change="ctrl.refreshMetricData()"
get-completions="ctrl.getCompletions($query)" data-mode="prometheus"> get-completer="ctrl.getCompleter()" data-mode="prometheus">
</code-editor> </code-editor>
</div> </div>
</div> </div>

View File

@@ -6,6 +6,7 @@ import moment from 'moment';
import * as dateMath from 'app/core/utils/datemath'; import * as dateMath from 'app/core/utils/datemath';
import {QueryCtrl} from 'app/plugins/sdk'; import {QueryCtrl} from 'app/plugins/sdk';
import {PromCompleter} from './completer';
class PrometheusQueryCtrl extends QueryCtrl { class PrometheusQueryCtrl extends QueryCtrl {
static templateUrl = 'partials/query.editor.html'; static templateUrl = 'partials/query.editor.html';
@@ -40,13 +41,14 @@ class PrometheusQueryCtrl extends QueryCtrl {
this.updateLink(); this.updateLink();
} }
getCompletions(query) { getCompleter(query) {
console.log(query); return new PromCompleter(this.datasource);
return this.datasource.performSuggestQuery(query).then(res => { // console.log('getquery);
return res.map(item => { // return this.datasource.performSuggestQuery(query).then(res => {
return {word: item, type: 'metric'}; // return res.map(item => {
}); // return {word: item, type: 'metric'};
}); // });
// });
} }
getDefaultFormat() { getDefaultFormat() {