datasource.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. define([
  2. 'angular',
  3. 'lodash',
  4. 'kbn',
  5. './queryCtrl',
  6. './directives',
  7. ],
  8. function (angular, _, kbn) {
  9. 'use strict';
  10. var module = angular.module('grafana.services');
  11. module.factory('KairosDBDatasource', function($q, backendSrv, templateSrv) {
  12. function KairosDBDatasource(datasource) {
  13. this.type = datasource.type;
  14. this.url = datasource.url;
  15. this.name = datasource.name;
  16. this.supportMetrics = true;
  17. }
  18. // Called once per panel (graph)
  19. KairosDBDatasource.prototype.query = function(options) {
  20. var start = options.range.from;
  21. var end = options.range.to;
  22. var queries = _.compact(_.map(options.targets, _.partial(convertTargetToQuery, options)));
  23. var plotParams = _.compact(_.map(options.targets, function(target) {
  24. var alias = target.alias;
  25. if (typeof target.alias === 'undefined' || target.alias === "") {
  26. alias = target.metric;
  27. }
  28. if (!target.hide) {
  29. return { alias: alias, exouter: target.exOuter };
  30. }
  31. else {
  32. return null;
  33. }
  34. }));
  35. var handleKairosDBQueryResponseAlias = _.partial(handleKairosDBQueryResponse, plotParams);
  36. // No valid targets, return the empty result to save a round trip.
  37. if (_.isEmpty(queries)) {
  38. var d = $q.defer();
  39. d.resolve({ data: [] });
  40. return d.promise;
  41. }
  42. return this.performTimeSeriesQuery(queries, start, end).then(handleKairosDBQueryResponseAlias, handleQueryError);
  43. };
  44. KairosDBDatasource.prototype.performTimeSeriesQuery = function(queries, start, end) {
  45. var reqBody = {
  46. metrics: queries,
  47. cache_time: 0
  48. };
  49. convertToKairosTime(start, reqBody, 'start');
  50. convertToKairosTime(end, reqBody, 'end');
  51. var options = {
  52. method: 'POST',
  53. url: this.url + '/api/v1/datapoints/query',
  54. data: reqBody
  55. };
  56. return backendSrv.datasourceRequest(options);
  57. };
  58. /**
  59. * Gets the list of metrics
  60. * @returns {*|Promise}
  61. */
  62. KairosDBDatasource.prototype._performMetricSuggestQuery = function(metric) {
  63. var options = {
  64. url: this.url + '/api/v1/metricnames',
  65. method: 'GET'
  66. };
  67. return backendSrv.datasourceRequest(options).then(function(response) {
  68. if (!response.data) {
  69. return $q.when([]);
  70. }
  71. var metrics = [];
  72. _.each(response.data.results, function(r) {
  73. if (r.indexOf(metric) >= 0) {
  74. metrics.push(r);
  75. }
  76. });
  77. return metrics;
  78. });
  79. };
  80. KairosDBDatasource.prototype._performMetricKeyLookup = function(metric) {
  81. if(!metric) { return $q.when([]); }
  82. var options = {
  83. method: 'POST',
  84. url: this.url + '/api/v1/datapoints/query/tags',
  85. data: {
  86. metrics: [{ name: metric }],
  87. cache_time: 0,
  88. start_absolute: 0
  89. }
  90. };
  91. return backendSrv.datasourceRequest(options).then(function(result) {
  92. if (!result.data) {
  93. return $q.when([]);
  94. }
  95. var tagks = [];
  96. _.each(result.data.queries[0].results[0].tags, function(tagv, tagk) {
  97. if(tagks.indexOf(tagk) === -1) {
  98. tagks.push(tagk);
  99. }
  100. });
  101. return tagks;
  102. });
  103. };
  104. KairosDBDatasource.prototype._performMetricKeyValueLookup = function(metric, key) {
  105. if(!metric || !key) {
  106. return $q.when([]);
  107. }
  108. var options = {
  109. method: 'POST',
  110. url: this.url + '/api/v1/datapoints/query/tags',
  111. data: {
  112. metrics: [{ name: metric }],
  113. cache_time: 0,
  114. start_absolute: 0
  115. }
  116. };
  117. return backendSrv.datasourceRequest(options).then(function(result) {
  118. if (!result.data) {
  119. return $q.when([]);
  120. }
  121. return result.data.queries[0].results[0].tags[key];
  122. });
  123. };
  124. KairosDBDatasource.prototype.performTagSuggestQuery = function(metric) {
  125. var options = {
  126. url: this.url + '/api/v1/datapoints/query/tags',
  127. method: 'POST',
  128. data: {
  129. metrics: [{ name: metric }],
  130. cache_time: 0,
  131. start_absolute: 0
  132. }
  133. };
  134. return backendSrv.datasourceRequest(options).then(function(response) {
  135. if (!response.data) {
  136. return [];
  137. }
  138. else {
  139. return response.data.queries[0].results[0];
  140. }
  141. });
  142. };
  143. KairosDBDatasource.prototype.metricFindQuery = function(query) {
  144. if (!query) { return $q.when([]); }
  145. var interpolated;
  146. try {
  147. interpolated = templateSrv.replace(query);
  148. }
  149. catch (err) {
  150. return $q.reject(err);
  151. }
  152. var responseTransform = function(result) {
  153. return _.map(result, function(value) {
  154. return {text: value};
  155. });
  156. };
  157. var metrics_regex = /metrics\((.*)\)/;
  158. var tag_names_regex = /tag_names\((.*)\)/;
  159. var tag_values_regex = /tag_values\((.*),\s?(.*?)\)/;
  160. var metrics_query = interpolated.match(metrics_regex);
  161. if (metrics_query) {
  162. return this._performMetricSuggestQuery(metrics_query[1]).then(responseTransform);
  163. }
  164. var tag_names_query = interpolated.match(tag_names_regex);
  165. if (tag_names_query) {
  166. return this._performMetricKeyLookup(tag_names_query[1]).then(responseTransform);
  167. }
  168. var tag_values_query = interpolated.match(tag_values_regex);
  169. if (tag_values_query) {
  170. return this._performMetricKeyValueLookup(tag_values_query[1], tag_values_query[2]).then(responseTransform);
  171. }
  172. return $q.when([]);
  173. };
  174. /////////////////////////////////////////////////////////////////////////
  175. /// Formatting methods
  176. ////////////////////////////////////////////////////////////////////////
  177. /**
  178. * Requires a verion of KairosDB with every CORS defects fixed
  179. * @param results
  180. * @returns {*}
  181. */
  182. function handleQueryError(results) {
  183. if (results.data.errors && !_.isEmpty(results.data.errors)) {
  184. var errors = {
  185. message: results.data.errors[0]
  186. };
  187. return $q.reject(errors);
  188. }
  189. else {
  190. return $q.reject(results);
  191. }
  192. }
  193. function handleKairosDBQueryResponse(plotParams, results) {
  194. var output = [];
  195. var index = 0;
  196. _.each(results.data.queries, function(series) {
  197. _.each(series.results, function(result) {
  198. var target = plotParams[index].alias;
  199. var details = " ( ";
  200. _.each(result.group_by, function(element) {
  201. if (element.name === "tag") {
  202. _.each(element.group, function(value, key) {
  203. details += key + "=" + value + " ";
  204. });
  205. }
  206. else if (element.name === "value") {
  207. details += 'value_group=' + element.group.group_number + " ";
  208. }
  209. else if (element.name === "time") {
  210. details += 'time_group=' + element.group.group_number + " ";
  211. }
  212. });
  213. details += ") ";
  214. if (details !== " ( ) ") {
  215. target += details;
  216. }
  217. var datapoints = [];
  218. for (var i = 0; i < result.values.length; i++) {
  219. var t = Math.floor(result.values[i][0]);
  220. var v = result.values[i][1];
  221. datapoints[i] = [v, t];
  222. }
  223. if (plotParams[index].exouter) {
  224. datapoints = new PeakFilter(datapoints, 10);
  225. }
  226. output.push({ target: target, datapoints: datapoints });
  227. });
  228. index++;
  229. });
  230. return { data: _.flatten(output) };
  231. }
  232. function convertTargetToQuery(options, target) {
  233. if (!target.metric || target.hide) {
  234. return null;
  235. }
  236. var query = {
  237. name: templateSrv.replace(target.metric)
  238. };
  239. query.aggregators = [];
  240. if (target.downsampling !== '(NONE)') {
  241. query.aggregators.push({
  242. name: target.downsampling,
  243. align_sampling: true,
  244. align_start_time: true,
  245. sampling: KairosDBDatasource.prototype.convertToKairosInterval(target.sampling || options.interval)
  246. });
  247. }
  248. if (target.horizontalAggregators) {
  249. _.each(target.horizontalAggregators, function(chosenAggregator) {
  250. var returnedAggregator = {
  251. name:chosenAggregator.name
  252. };
  253. if (chosenAggregator.sampling_rate) {
  254. returnedAggregator.sampling = KairosDBDatasource.prototype.convertToKairosInterval(chosenAggregator.sampling_rate);
  255. returnedAggregator.align_sampling = true;
  256. returnedAggregator.align_start_time =true;
  257. }
  258. if (chosenAggregator.unit) {
  259. returnedAggregator.unit = chosenAggregator.unit + 's';
  260. }
  261. if (chosenAggregator.factor && chosenAggregator.name === 'div') {
  262. returnedAggregator.divisor = chosenAggregator.factor;
  263. }
  264. else if (chosenAggregator.factor && chosenAggregator.name === 'scale') {
  265. returnedAggregator.factor = chosenAggregator.factor;
  266. }
  267. if (chosenAggregator.percentile) {
  268. returnedAggregator.percentile = chosenAggregator.percentile;
  269. }
  270. query.aggregators.push(returnedAggregator);
  271. });
  272. }
  273. if (_.isEmpty(query.aggregators)) {
  274. delete query.aggregators;
  275. }
  276. if (target.tags) {
  277. query.tags = angular.copy(target.tags);
  278. _.forOwn(query.tags, function(value, key) {
  279. query.tags[key] = _.map(value, function(tag) { return templateSrv.replace(tag); });
  280. });
  281. }
  282. if (target.groupByTags || target.nonTagGroupBys) {
  283. query.group_by = [];
  284. if (target.groupByTags) {
  285. query.group_by.push({
  286. name: "tag",
  287. tags: _.map(angular.copy(target.groupByTags), function(tag) { return templateSrv.replace(tag); })
  288. });
  289. }
  290. if (target.nonTagGroupBys) {
  291. _.each(target.nonTagGroupBys, function(rawGroupBy) {
  292. var formattedGroupBy = angular.copy(rawGroupBy);
  293. if (formattedGroupBy.name === 'time') {
  294. formattedGroupBy.range_size = KairosDBDatasource.prototype.convertToKairosInterval(formattedGroupBy.range_size);
  295. }
  296. query.group_by.push(formattedGroupBy);
  297. });
  298. }
  299. }
  300. return query;
  301. }
  302. ///////////////////////////////////////////////////////////////////////
  303. /// Time conversion functions specifics to KairosDB
  304. //////////////////////////////////////////////////////////////////////
  305. KairosDBDatasource.prototype.convertToKairosInterval = function(intervalString) {
  306. intervalString = templateSrv.replace(intervalString);
  307. var interval_regex = /(\d+(?:\.\d+)?)([Mwdhmsy])/;
  308. var interval_regex_ms = /(\d+(?:\.\d+)?)(ms)/;
  309. var matches = intervalString.match(interval_regex_ms);
  310. if (!matches) {
  311. matches = intervalString.match(interval_regex);
  312. }
  313. if (!matches) {
  314. throw new Error('Invalid interval string, expecting a number followed by one of "y M w d h m s ms"');
  315. }
  316. var value = matches[1];
  317. var unit = matches[2];
  318. if (value%1 !== 0) {
  319. if (unit === 'ms') {
  320. throw new Error('Invalid interval value, cannot be smaller than the millisecond');
  321. }
  322. value = Math.round(kbn.intervals_in_seconds[unit] * value * 1000);
  323. unit = 'ms';
  324. }
  325. return {
  326. value: value,
  327. unit: convertToKairosDBTimeUnit(unit)
  328. };
  329. };
  330. function convertToKairosTime(date, response_obj, start_stop_name) {
  331. var name;
  332. if (_.isString(date)) {
  333. if (date === 'now') {
  334. return;
  335. }
  336. else if (date.indexOf('now-') >= 0) {
  337. date = date.substring(4);
  338. name = start_stop_name + "_relative";
  339. var re_date = /(\d+)\s*(\D+)/;
  340. var result = re_date.exec(date);
  341. if (result) {
  342. var value = result[1];
  343. var unit = result[2];
  344. response_obj[name] = {
  345. value: value,
  346. unit: convertToKairosDBTimeUnit(unit)
  347. };
  348. return;
  349. }
  350. console.log("Unparseable date", date);
  351. return;
  352. }
  353. date = kbn.parseDate(date);
  354. }
  355. if (_.isDate(date)) {
  356. name = start_stop_name + "_absolute";
  357. response_obj[name] = date.getTime();
  358. return;
  359. }
  360. console.log("Date is neither string nor date");
  361. }
  362. function convertToKairosDBTimeUnit(unit) {
  363. switch (unit) {
  364. case 'ms':
  365. return 'milliseconds';
  366. case 's':
  367. return 'seconds';
  368. case 'm':
  369. return 'minutes';
  370. case 'h':
  371. return 'hours';
  372. case 'd':
  373. return 'days';
  374. case 'w':
  375. return 'weeks';
  376. case 'M':
  377. return 'months';
  378. case 'y':
  379. return 'years';
  380. default:
  381. console.log("Unknown unit ", unit);
  382. return '';
  383. }
  384. }
  385. function PeakFilter(dataIn, limit) {
  386. var datapoints = dataIn;
  387. var arrLength = datapoints.length;
  388. if (arrLength <= 3) {
  389. return datapoints;
  390. }
  391. var LastIndx = arrLength - 1;
  392. // Check first point
  393. var prvDelta = Math.abs((datapoints[1][0] - datapoints[0][0]) / datapoints[0][0]);
  394. var nxtDelta = Math.abs((datapoints[1][0] - datapoints[2][0]) / datapoints[2][0]);
  395. if (prvDelta >= limit && nxtDelta < limit) {
  396. datapoints[0][0] = datapoints[1][0];
  397. }
  398. // Check last point
  399. prvDelta = Math.abs((datapoints[LastIndx - 1][0] - datapoints[LastIndx - 2][0]) / datapoints[LastIndx - 2][0]);
  400. nxtDelta = Math.abs((datapoints[LastIndx - 1][0] - datapoints[LastIndx][0]) / datapoints[LastIndx][0]);
  401. if (prvDelta >= limit && nxtDelta < limit) {
  402. datapoints[LastIndx][0] = datapoints[LastIndx - 1][0];
  403. }
  404. for (var i = 1; i < arrLength - 1; i++) {
  405. prvDelta = Math.abs((datapoints[i][0] - datapoints[i - 1][0]) / datapoints[i - 1][0]);
  406. nxtDelta = Math.abs((datapoints[i][0] - datapoints[i + 1][0]) / datapoints[i + 1][0]);
  407. if (prvDelta >= limit && nxtDelta >= limit) {
  408. datapoints[i][0] = (datapoints[i - 1][0] + datapoints[i + 1][0]) / 2;
  409. }
  410. }
  411. return datapoints;
  412. }
  413. return KairosDBDatasource;
  414. });
  415. });