datasource.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. ///<reference path="../../../headers/common.d.ts" />
  2. import angular from 'angular';
  3. import _ from 'lodash';
  4. import moment from 'moment';
  5. import kbn from 'app/core/utils/kbn';
  6. import * as dateMath from 'app/core/utils/datemath';
  7. import PrometheusMetricFindQuery from './metric_find_query';
  8. import TableModel from 'app/core/table_model';
  9. var durationSplitRegexp = /(\d+)(ms|s|m|h|d|w|M|y)/;
  10. /** @ngInject */
  11. export function PrometheusDatasource(instanceSettings, $q, backendSrv, templateSrv, timeSrv) {
  12. this.type = 'prometheus';
  13. this.editorSrc = 'app/features/prometheus/partials/query.editor.html';
  14. this.name = instanceSettings.name;
  15. this.supportMetrics = true;
  16. this.url = instanceSettings.url;
  17. this.directUrl = instanceSettings.directUrl;
  18. this.basicAuth = instanceSettings.basicAuth;
  19. this.withCredentials = instanceSettings.withCredentials;
  20. this._request = function(method, url, requestId) {
  21. var options: any = {
  22. url: this.url + url,
  23. method: method,
  24. requestId: requestId,
  25. };
  26. if (this.basicAuth || this.withCredentials) {
  27. options.withCredentials = true;
  28. }
  29. if (this.basicAuth) {
  30. options.headers = {
  31. "Authorization": this.basicAuth
  32. };
  33. }
  34. return backendSrv.datasourceRequest(options);
  35. };
  36. function prometheusSpecialRegexEscape(value) {
  37. return value.replace(/[\\^$*+?.()|[\]{}]/g, '\\\\$&');
  38. }
  39. this.interpolateQueryExpr = function(value, variable, defaultFormatFn) {
  40. // if no multi or include all do not regexEscape
  41. if (!variable.multi && !variable.includeAll) {
  42. return value;
  43. }
  44. if (typeof value === 'string') {
  45. return prometheusSpecialRegexEscape(value);
  46. }
  47. var escapedValues = _.map(value, prometheusSpecialRegexEscape);
  48. return escapedValues.join('|');
  49. };
  50. this.targetContainsTemplate = function(target) {
  51. return templateSrv.variableExists(target.expr);
  52. };
  53. // Called once per panel (graph)
  54. this.query = function(options) {
  55. var self = this;
  56. var start = this.getPrometheusTime(options.range.from, false);
  57. var end = this.getPrometheusTime(options.range.to, true);
  58. var queries = [];
  59. var activeTargets = [];
  60. options = _.clone(options);
  61. for (let target of options.targets) {
  62. if (!target.expr || target.hide) {
  63. return;
  64. }
  65. activeTargets.push(target);
  66. var query: any = {};
  67. query.expr = templateSrv.replace(target.expr, options.scopedVars, self.interpolateQueryExpr);
  68. query.requestId = options.panelId + target.refId;
  69. var interval = templateSrv.replace(target.interval, options.scopedVars) || options.interval;
  70. var intervalFactor = target.intervalFactor || 1;
  71. target.step = query.step = this.calculateInterval(interval, intervalFactor);
  72. var range = Math.ceil(end - start);
  73. target.step = query.step = this.adjustStep(query.step, this.intervalSeconds(options.interval), range);
  74. queries.push(query);
  75. }
  76. // No valid targets, return the empty result to save a round trip.
  77. if (_.isEmpty(queries)) {
  78. return $q.when({ data: [] });
  79. }
  80. var allQueryPromise = _.map(queries, query => {
  81. return this.performTimeSeriesQuery(query, start, end);
  82. });
  83. return $q.all(allQueryPromise).then(responseList => {
  84. var result = [];
  85. var index = 0;
  86. _.each(responseList, (response, index) => {
  87. if (response.status === 'error') {
  88. throw response.error;
  89. }
  90. if (activeTargets[index].format === "table") {
  91. result.push(self.transformMetricDataToTable(response.data.data.result));
  92. } else {
  93. for (let metricData of response.data.data.result) {
  94. result.push(self.transformMetricData(metricData, activeTargets[index], start, end));
  95. }
  96. }
  97. });
  98. return { data: result };
  99. });
  100. };
  101. this.adjustStep = function(step, autoStep, range) {
  102. // Prometheus drop query if range/step > 11000
  103. // calibrate step if it is too big
  104. if (step !== 0 && range / step > 11000) {
  105. return Math.ceil(range / 11000);
  106. }
  107. return Math.max(step, autoStep);
  108. };
  109. this.performTimeSeriesQuery = function(query, start, end) {
  110. if (start > end) {
  111. throw { message: 'Invalid time range' };
  112. }
  113. var url = '/api/v1/query_range?query=' + encodeURIComponent(query.expr) + '&start=' + start + '&end=' + end + '&step=' + query.step;
  114. return this._request('GET', url, query.requestId);
  115. };
  116. this.performSuggestQuery = function(query) {
  117. var url = '/api/v1/label/__name__/values';
  118. return this._request('GET', url).then(function(result) {
  119. return _.filter(result.data.data, function (metricName) {
  120. return metricName.indexOf(query) !== 1;
  121. });
  122. });
  123. };
  124. this.metricFindQuery = function(query) {
  125. if (!query) { return $q.when([]); }
  126. var interpolated;
  127. try {
  128. interpolated = templateSrv.replace(query, {}, this.interpolateQueryExpr);
  129. } catch (err) {
  130. return $q.reject(err);
  131. }
  132. var metricFindQuery = new PrometheusMetricFindQuery(this, interpolated, timeSrv);
  133. return metricFindQuery.process();
  134. };
  135. this.annotationQuery = function(options) {
  136. var annotation = options.annotation;
  137. var expr = annotation.expr || '';
  138. var tagKeys = annotation.tagKeys || '';
  139. var titleFormat = annotation.titleFormat || '';
  140. var textFormat = annotation.textFormat || '';
  141. if (!expr) { return $q.when([]); }
  142. var interpolated;
  143. try {
  144. interpolated = templateSrv.replace(expr, {}, this.interpolateQueryExpr);
  145. } catch (err) {
  146. return $q.reject(err);
  147. }
  148. var step = '60s';
  149. if (annotation.step) {
  150. step = templateSrv.replace(annotation.step);
  151. }
  152. var start = this.getPrometheusTime(options.range.from, false);
  153. var end = this.getPrometheusTime(options.range.to, true);
  154. var query = {
  155. expr: interpolated,
  156. step: this.adjustStep(kbn.interval_to_seconds(step), 0, Math.ceil(end - start)) + 's'
  157. };
  158. var self = this;
  159. return this.performTimeSeriesQuery(query, start, end).then(function(results) {
  160. var eventList = [];
  161. tagKeys = tagKeys.split(',');
  162. _.each(results.data.data.result, function(series) {
  163. var tags = _.chain(series.metric)
  164. .filter(function(v, k) {
  165. return _.includes(tagKeys, k);
  166. }).value();
  167. _.each(series.values, function(value) {
  168. if (value[1] === '1') {
  169. var event = {
  170. annotation: annotation,
  171. time: Math.floor(value[0]) * 1000,
  172. title: self.renderTemplate(titleFormat, series.metric),
  173. tags: tags,
  174. text: self.renderTemplate(textFormat, series.metric)
  175. };
  176. eventList.push(event);
  177. }
  178. });
  179. });
  180. return eventList;
  181. });
  182. };
  183. this.testDatasource = function() {
  184. return this.metricFindQuery('metrics(.*)').then(function() {
  185. return { status: 'success', message: 'Data source is working', title: 'Success' };
  186. });
  187. };
  188. this.calculateInterval = function(interval, intervalFactor) {
  189. return Math.ceil(this.intervalSeconds(interval) * intervalFactor);
  190. };
  191. this.intervalSeconds = function(interval) {
  192. var m = interval.match(durationSplitRegexp);
  193. var dur = moment.duration(parseInt(m[1]), m[2]);
  194. var sec = dur.asSeconds();
  195. if (sec < 1) {
  196. sec = 1;
  197. }
  198. return sec;
  199. };
  200. this.transformMetricData = function(md, options, start, end) {
  201. var dps = [],
  202. metricLabel = null;
  203. metricLabel = this.createMetricLabel(md.metric, options);
  204. var stepMs = parseInt(options.step) * 1000;
  205. var baseTimestamp = start * 1000;
  206. _.each(md.values, function(value) {
  207. var dp_value = parseFloat(value[1]);
  208. if (_.isNaN(dp_value)) {
  209. dp_value = null;
  210. }
  211. var timestamp = value[0] * 1000;
  212. for (var t = baseTimestamp; t < timestamp; t += stepMs) {
  213. dps.push([null, t]);
  214. }
  215. baseTimestamp = timestamp + stepMs;
  216. dps.push([dp_value, timestamp]);
  217. });
  218. var endTimestamp = end * 1000;
  219. for (var t = baseTimestamp; t <= endTimestamp; t += stepMs) {
  220. dps.push([null, t]);
  221. }
  222. return { target: metricLabel, datapoints: dps };
  223. };
  224. this.transformMetricDataToTable = function(series) {
  225. var table = new TableModel();
  226. var self = this;
  227. var i, j;
  228. if (series.length === 0) {
  229. return table;
  230. }
  231. _.each(series, function(series, seriesIndex) {
  232. if (seriesIndex === 0) {
  233. table.columns.push({text: 'Time', type: 'time'});
  234. _.each(_.keys(series.metric), function(key) {
  235. table.columns.push({text: key});
  236. });
  237. table.columns.push({text: 'Value'});
  238. }
  239. if (series.values) {
  240. for (i = 0; i < series.values.length; i++) {
  241. var values = series.values[i];
  242. var reordered = [values[0] * 1000];
  243. if (series.metric) {
  244. for (var key in series.metric) {
  245. if (series.metric.hasOwnProperty(key)) {
  246. reordered.push(series.metric[key]);
  247. }
  248. }
  249. }
  250. reordered.push(parseFloat(values[1]));
  251. table.rows.push(reordered);
  252. }
  253. }
  254. });
  255. return table;
  256. };
  257. this.createMetricLabel = function(labelData, options) {
  258. if (_.isUndefined(options) || _.isEmpty(options.legendFormat)) {
  259. return this.getOriginalMetricName(labelData);
  260. }
  261. return this.renderTemplate(templateSrv.replace(options.legendFormat), labelData) || '{}';
  262. };
  263. this.renderTemplate = function(aliasPattern, aliasData) {
  264. var aliasRegex = /\{\{\s*(.+?)\s*\}\}/g;
  265. return aliasPattern.replace(aliasRegex, function(match, g1) {
  266. if (aliasData[g1]) {
  267. return aliasData[g1];
  268. }
  269. return g1;
  270. });
  271. };
  272. this.getOriginalMetricName = function(labelData) {
  273. var metricName = labelData.__name__ || '';
  274. delete labelData.__name__;
  275. var labelPart = _.map(_.toPairs(labelData), function(label) {
  276. return label[0] + '="' + label[1] + '"';
  277. }).join(',');
  278. return metricName + '{' + labelPart + '}';
  279. };
  280. this.getPrometheusTime = function(date, roundUp) {
  281. if (_.isString(date)) {
  282. date = dateMath.parse(date, roundUp);
  283. }
  284. return Math.ceil(date.valueOf() / 1000);
  285. };
  286. }