datasource.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. define([
  2. 'angular',
  3. 'lodash',
  4. 'app/core/utils/datemath',
  5. 'moment',
  6. ],
  7. function (angular, _, dateMath) {
  8. 'use strict';
  9. /** @ngInject */
  10. function OpenTsDatasource(instanceSettings, $q, backendSrv, templateSrv) {
  11. this.type = 'opentsdb';
  12. this.url = instanceSettings.url;
  13. this.name = instanceSettings.name;
  14. this.withCredentials = instanceSettings.withCredentials;
  15. this.basicAuth = instanceSettings.basicAuth;
  16. instanceSettings.jsonData = instanceSettings.jsonData || {};
  17. this.tsdbVersion = instanceSettings.jsonData.tsdbVersion || 1;
  18. this.tsdbResolution = instanceSettings.jsonData.tsdbResolution || 1;
  19. this.supportMetrics = true;
  20. this.tagKeys = {};
  21. // Called once per panel (graph)
  22. this.query = function(options) {
  23. var start = convertToTSDBTime(options.rangeRaw.from, false);
  24. var end = convertToTSDBTime(options.rangeRaw.to, true);
  25. var qs = [];
  26. _.each(options.targets, function(target) {
  27. if (!target.metric) { return; }
  28. qs.push(convertTargetToQuery(target, options));
  29. });
  30. var queries = _.compact(qs);
  31. // No valid targets, return the empty result to save a round trip.
  32. if (_.isEmpty(queries)) {
  33. var d = $q.defer();
  34. d.resolve({ data: [] });
  35. return d.promise;
  36. }
  37. var groupByTags = {};
  38. _.each(queries, function(query) {
  39. if (query.filters && query.filters.length > 0) {
  40. _.each(query.filters, function(val) {
  41. groupByTags[val.tagk] = true;
  42. });
  43. } else {
  44. _.each(query.tags, function(val, key) {
  45. groupByTags[key] = true;
  46. });
  47. }
  48. });
  49. return this.performTimeSeriesQuery(queries, start, end).then(function(response) {
  50. var metricToTargetMapping = mapMetricsToTargets(response.data, options, this.tsdbVersion);
  51. var result = _.map(response.data, function(metricData, index) {
  52. index = metricToTargetMapping[index];
  53. if (index === -1) {
  54. index = 0;
  55. }
  56. this._saveTagKeys(metricData);
  57. return transformMetricData(metricData, groupByTags, options.targets[index], options, this.tsdbResolution);
  58. }.bind(this));
  59. return { data: result };
  60. }.bind(this));
  61. };
  62. this.annotationQuery = function(options) {
  63. var start = convertToTSDBTime(options.rangeRaw.from, false);
  64. var end = convertToTSDBTime(options.rangeRaw.to, true);
  65. var qs = [];
  66. var eventList = [];
  67. qs.push({ aggregator:"sum", metric:options.annotation.target });
  68. var queries = _.compact(qs);
  69. return this.performTimeSeriesQuery(queries, start, end).then(function(results) {
  70. if(results.data[0]) {
  71. var annotationObject = results.data[0].annotations;
  72. if(options.annotation.isGlobal){
  73. annotationObject = results.data[0].globalAnnotations;
  74. }
  75. if(annotationObject) {
  76. _.each(annotationObject, function(annotation) {
  77. var event = {
  78. title: annotation.description,
  79. time: Math.floor(annotation.startTime) * 1000,
  80. text: annotation.notes,
  81. annotation: options.annotation
  82. };
  83. eventList.push(event);
  84. });
  85. }
  86. }
  87. return eventList;
  88. }.bind(this));
  89. };
  90. this.targetContainsTemplate = function(target) {
  91. if (target.filters && target.filters.length > 0) {
  92. for (var i = 0; i < target.filters.length; i++) {
  93. if (templateSrv.variableExists(target.filters[i].filter)) {
  94. return true;
  95. }
  96. }
  97. }
  98. if (target.tags && Object.keys(target.tags).length > 0) {
  99. for (var tagKey in target.tags) {
  100. if (templateSrv.variableExists(target.tags[tagKey])) {
  101. return true;
  102. }
  103. }
  104. }
  105. return false;
  106. };
  107. this.performTimeSeriesQuery = function(queries, start, end) {
  108. var msResolution = false;
  109. if (this.tsdbResolution === 2) {
  110. msResolution = true;
  111. }
  112. var reqBody = {
  113. start: start,
  114. queries: queries,
  115. msResolution: msResolution,
  116. globalAnnotations: true
  117. };
  118. if (this.tsdbVersion === 3) {
  119. reqBody.showQuery = true;
  120. }
  121. // Relative queries (e.g. last hour) don't include an end time
  122. if (end) {
  123. reqBody.end = end;
  124. }
  125. var options = {
  126. method: 'POST',
  127. url: this.url + '/api/query',
  128. data: reqBody
  129. };
  130. this._addCredentialOptions(options);
  131. return backendSrv.datasourceRequest(options);
  132. };
  133. this.suggestTagKeys = function(metric) {
  134. return $q.when(this.tagKeys[metric] || []);
  135. };
  136. this._saveTagKeys = function(metricData) {
  137. var tagKeys = Object.keys(metricData.tags);
  138. _.each(metricData.aggregateTags, function(tag) {
  139. tagKeys.push(tag);
  140. });
  141. this.tagKeys[metricData.metric] = tagKeys;
  142. };
  143. this._performSuggestQuery = function(query, type) {
  144. return this._get('/api/suggest', {type: type, q: query, max: 1000}).then(function(result) {
  145. return result.data;
  146. });
  147. };
  148. this._performMetricKeyValueLookup = function(metric, keys) {
  149. if(!metric || !keys) {
  150. return $q.when([]);
  151. }
  152. var keysArray = keys.split(",").map(function(key) {
  153. return key.trim();
  154. });
  155. var key = keysArray[0];
  156. var keysQuery = key + "=*";
  157. if (keysArray.length > 1) {
  158. keysQuery += "," + keysArray.splice(1).join(",");
  159. }
  160. var m = metric + "{" + keysQuery + "}";
  161. return this._get('/api/search/lookup', {m: m, limit: 3000}).then(function(result) {
  162. result = result.data.results;
  163. var tagvs = [];
  164. _.each(result, function(r) {
  165. if (tagvs.indexOf(r.tags[key]) === -1) {
  166. tagvs.push(r.tags[key]);
  167. }
  168. });
  169. return tagvs;
  170. });
  171. };
  172. this._performMetricKeyLookup = function(metric) {
  173. if(!metric) { return $q.when([]); }
  174. return this._get('/api/search/lookup', {m: metric, limit: 1000}).then(function(result) {
  175. result = result.data.results;
  176. var tagks = [];
  177. _.each(result, function(r) {
  178. _.each(r.tags, function(tagv, tagk) {
  179. if(tagks.indexOf(tagk) === -1) {
  180. tagks.push(tagk);
  181. }
  182. });
  183. });
  184. return tagks;
  185. });
  186. };
  187. this._get = function(relativeUrl, params) {
  188. var options = {
  189. method: 'GET',
  190. url: this.url + relativeUrl,
  191. params: params,
  192. };
  193. this._addCredentialOptions(options);
  194. return backendSrv.datasourceRequest(options);
  195. };
  196. this._addCredentialOptions = function(options) {
  197. if (this.basicAuth || this.withCredentials) {
  198. options.withCredentials = true;
  199. }
  200. if (this.basicAuth) {
  201. options.headers = {"Authorization": this.basicAuth};
  202. }
  203. };
  204. this.metricFindQuery = function(query) {
  205. if (!query) { return $q.when([]); }
  206. var interpolated;
  207. try {
  208. interpolated = templateSrv.replace(query, {}, 'distributed');
  209. }
  210. catch (err) {
  211. return $q.reject(err);
  212. }
  213. var responseTransform = function(result) {
  214. return _.map(result, function(value) {
  215. return {text: value};
  216. });
  217. };
  218. var metrics_regex = /metrics\((.*)\)/;
  219. var tag_names_regex = /tag_names\((.*)\)/;
  220. var tag_values_regex = /tag_values\((.*?),\s?(.*)\)/;
  221. var tag_names_suggest_regex = /suggest_tagk\((.*)\)/;
  222. var tag_values_suggest_regex = /suggest_tagv\((.*)\)/;
  223. var metrics_query = interpolated.match(metrics_regex);
  224. if (metrics_query) {
  225. return this._performSuggestQuery(metrics_query[1], 'metrics').then(responseTransform);
  226. }
  227. var tag_names_query = interpolated.match(tag_names_regex);
  228. if (tag_names_query) {
  229. return this._performMetricKeyLookup(tag_names_query[1]).then(responseTransform);
  230. }
  231. var tag_values_query = interpolated.match(tag_values_regex);
  232. if (tag_values_query) {
  233. return this._performMetricKeyValueLookup(tag_values_query[1], tag_values_query[2]).then(responseTransform);
  234. }
  235. var tag_names_suggest_query = interpolated.match(tag_names_suggest_regex);
  236. if (tag_names_suggest_query) {
  237. return this._performSuggestQuery(tag_names_suggest_query[1], 'tagk').then(responseTransform);
  238. }
  239. var tag_values_suggest_query = interpolated.match(tag_values_suggest_regex);
  240. if (tag_values_suggest_query) {
  241. return this._performSuggestQuery(tag_values_suggest_query[1], 'tagv').then(responseTransform);
  242. }
  243. return $q.when([]);
  244. };
  245. this.testDatasource = function() {
  246. return this._performSuggestQuery('cpu', 'metrics').then(function () {
  247. return { status: "success", message: "Data source is working", title: "Success" };
  248. });
  249. };
  250. var aggregatorsPromise = null;
  251. this.getAggregators = function() {
  252. if (aggregatorsPromise) { return aggregatorsPromise; }
  253. aggregatorsPromise = this._get('/api/aggregators').then(function(result) {
  254. if (result.data && _.isArray(result.data)) {
  255. return result.data.sort();
  256. }
  257. return [];
  258. });
  259. return aggregatorsPromise;
  260. };
  261. var filterTypesPromise = null;
  262. this.getFilterTypes = function() {
  263. if (filterTypesPromise) { return filterTypesPromise; }
  264. filterTypesPromise = this._get('/api/config/filters').then(function(result) {
  265. if (result.data) {
  266. return Object.keys(result.data).sort();
  267. }
  268. return [];
  269. });
  270. return filterTypesPromise;
  271. };
  272. function transformMetricData(md, groupByTags, target, options, tsdbResolution) {
  273. var metricLabel = createMetricLabel(md, target, groupByTags, options);
  274. var dps = [];
  275. // TSDB returns datapoints has a hash of ts => value.
  276. // Can't use _.pairs(invert()) because it stringifies keys/values
  277. _.each(md.dps, function (v, k) {
  278. if (tsdbResolution === 2) {
  279. dps.push([v, k * 1]);
  280. } else {
  281. dps.push([v, k * 1000]);
  282. }
  283. });
  284. return { target: metricLabel, datapoints: dps };
  285. }
  286. function createMetricLabel(md, target, groupByTags, options) {
  287. if (target.alias) {
  288. var scopedVars = _.clone(options.scopedVars || {});
  289. _.each(md.tags, function(value, key) {
  290. scopedVars['tag_' + key] = {value: value};
  291. });
  292. return templateSrv.replace(target.alias, scopedVars);
  293. }
  294. var label = md.metric;
  295. var tagData = [];
  296. if (!_.isEmpty(md.tags)) {
  297. _.each(_.toPairs(md.tags), function(tag) {
  298. if (_.has(groupByTags, tag[0])) {
  299. tagData.push(tag[0] + "=" + tag[1]);
  300. }
  301. });
  302. }
  303. if (!_.isEmpty(tagData)) {
  304. label += "{" + tagData.join(", ") + "}";
  305. }
  306. return label;
  307. }
  308. function convertTargetToQuery(target, options) {
  309. if (!target.metric || target.hide) {
  310. return null;
  311. }
  312. var query = {
  313. metric: templateSrv.replace(target.metric, options.scopedVars),
  314. aggregator: "avg"
  315. };
  316. if (target.aggregator) {
  317. query.aggregator = templateSrv.replace(target.aggregator);
  318. }
  319. if (target.shouldComputeRate) {
  320. query.rate = true;
  321. query.rateOptions = {
  322. counter: !!target.isCounter
  323. };
  324. if (target.counterMax && target.counterMax.length) {
  325. query.rateOptions.counterMax = parseInt(target.counterMax);
  326. }
  327. if (target.counterResetValue && target.counterResetValue.length) {
  328. query.rateOptions.resetValue = parseInt(target.counterResetValue);
  329. }
  330. }
  331. if (!target.disableDownsampling) {
  332. var interval = templateSrv.replace(target.downsampleInterval || options.interval);
  333. if (interval.match(/\.[0-9]+s/)) {
  334. interval = parseFloat(interval)*1000 + "ms";
  335. }
  336. query.downsample = interval + "-" + target.downsampleAggregator;
  337. if (target.downsampleFillPolicy && target.downsampleFillPolicy !== "none") {
  338. query.downsample += "-" + target.downsampleFillPolicy;
  339. }
  340. }
  341. if (target.filters && target.filters.length > 0) {
  342. query.filters = angular.copy(target.filters);
  343. if(query.filters){
  344. for(var filter_key in query.filters){
  345. query.filters[filter_key].filter = templateSrv.replace(query.filters[filter_key].filter, options.scopedVars, 'pipe');
  346. }
  347. }
  348. } else {
  349. query.tags = angular.copy(target.tags);
  350. if(query.tags){
  351. for(var tag_key in query.tags){
  352. query.tags[tag_key] = templateSrv.replace(query.tags[tag_key], options.scopedVars, 'pipe');
  353. }
  354. }
  355. }
  356. if (target.explicitTags) {
  357. query.explicitTags = true;
  358. }
  359. return query;
  360. }
  361. function mapMetricsToTargets(metrics, options, tsdbVersion) {
  362. var interpolatedTagValue;
  363. return _.map(metrics, function(metricData) {
  364. if (tsdbVersion === 3) {
  365. return metricData.query.index;
  366. } else {
  367. return _.findIndex(options.targets, function(target) {
  368. if (target.filters && target.filters.length > 0) {
  369. return target.metric === metricData.metric;
  370. } else {
  371. return target.metric === metricData.metric &&
  372. _.every(target.tags, function(tagV, tagK) {
  373. interpolatedTagValue = templateSrv.replace(tagV, options.scopedVars, 'pipe');
  374. return metricData.tags[tagK] === interpolatedTagValue || interpolatedTagValue === "*";
  375. });
  376. }
  377. });
  378. }
  379. });
  380. }
  381. function convertToTSDBTime(date, roundUp) {
  382. if (date === 'now') {
  383. return null;
  384. }
  385. date = dateMath.parse(date, roundUp);
  386. return date.valueOf();
  387. }
  388. }
  389. return {
  390. OpenTsDatasource: OpenTsDatasource
  391. };
  392. });