datasource.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  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.performTimeSeriesQuery = function(queries, start, end) {
  91. var msResolution = false;
  92. if (this.tsdbResolution === 2) {
  93. msResolution = true;
  94. }
  95. var reqBody = {
  96. start: start,
  97. queries: queries,
  98. msResolution: msResolution,
  99. globalAnnotations: true
  100. };
  101. if (this.tsdbVersion === 3) {
  102. reqBody.showQuery = true;
  103. }
  104. // Relative queries (e.g. last hour) don't include an end time
  105. if (end) {
  106. reqBody.end = end;
  107. }
  108. var options = {
  109. method: 'POST',
  110. url: this.url + '/api/query',
  111. data: reqBody
  112. };
  113. if (this.basicAuth || this.withCredentials) {
  114. options.withCredentials = true;
  115. }
  116. if (this.basicAuth) {
  117. options.headers = {"Authorization": this.basicAuth};
  118. }
  119. // In case the backend is 3rd-party hosted and does not suport OPTIONS, urlencoded requests
  120. // go as POST rather than OPTIONS+POST
  121. options.headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
  122. return backendSrv.datasourceRequest(options);
  123. };
  124. this.suggestTagKeys = function(metric) {
  125. return $q.when(this.tagKeys[metric] || []);
  126. };
  127. this._saveTagKeys = function(metricData) {
  128. var tagKeys = Object.keys(metricData.tags);
  129. _.each(metricData.aggregateTags, function(tag) {
  130. tagKeys.push(tag);
  131. });
  132. this.tagKeys[metricData.metric] = tagKeys;
  133. };
  134. this._performSuggestQuery = function(query, type) {
  135. return this._get('/api/suggest', {type: type, q: query, max: 1000}).then(function(result) {
  136. return result.data;
  137. });
  138. };
  139. this._performMetricKeyValueLookup = function(metric, keys) {
  140. if(!metric || !keys) {
  141. return $q.when([]);
  142. }
  143. var keysArray = keys.split(",").map(function(key) {
  144. return key.trim();
  145. });
  146. var key = keysArray[0];
  147. var keysQuery = key + "=*";
  148. if (keysArray.length > 1) {
  149. keysQuery += "," + keysArray.splice(1).join(",");
  150. }
  151. var m = metric + "{" + keysQuery + "}";
  152. return this._get('/api/search/lookup', {m: m, limit: 3000}).then(function(result) {
  153. result = result.data.results;
  154. var tagvs = [];
  155. _.each(result, function(r) {
  156. if (tagvs.indexOf(r.tags[key]) === -1) {
  157. tagvs.push(r.tags[key]);
  158. }
  159. });
  160. return tagvs;
  161. });
  162. };
  163. this._performMetricKeyLookup = function(metric) {
  164. if(!metric) { return $q.when([]); }
  165. return this._get('/api/search/lookup', {m: metric, limit: 1000}).then(function(result) {
  166. result = result.data.results;
  167. var tagks = [];
  168. _.each(result, function(r) {
  169. _.each(r.tags, function(tagv, tagk) {
  170. if(tagks.indexOf(tagk) === -1) {
  171. tagks.push(tagk);
  172. }
  173. });
  174. });
  175. return tagks;
  176. });
  177. };
  178. this._get = function(relativeUrl, params) {
  179. return backendSrv.datasourceRequest({
  180. method: 'GET',
  181. url: this.url + relativeUrl,
  182. params: params,
  183. });
  184. };
  185. this.metricFindQuery = function(query) {
  186. if (!query) { return $q.when([]); }
  187. var interpolated;
  188. try {
  189. interpolated = templateSrv.replace(query);
  190. }
  191. catch (err) {
  192. return $q.reject(err);
  193. }
  194. var responseTransform = function(result) {
  195. return _.map(result, function(value) {
  196. return {text: value};
  197. });
  198. };
  199. var metrics_regex = /metrics\((.*)\)/;
  200. var tag_names_regex = /tag_names\((.*)\)/;
  201. var tag_values_regex = /tag_values\((.*?),\s?(.*)\)/;
  202. var tag_names_suggest_regex = /suggest_tagk\((.*)\)/;
  203. var tag_values_suggest_regex = /suggest_tagv\((.*)\)/;
  204. var metrics_query = interpolated.match(metrics_regex);
  205. if (metrics_query) {
  206. return this._performSuggestQuery(metrics_query[1], 'metrics').then(responseTransform);
  207. }
  208. var tag_names_query = interpolated.match(tag_names_regex);
  209. if (tag_names_query) {
  210. return this._performMetricKeyLookup(tag_names_query[1]).then(responseTransform);
  211. }
  212. var tag_values_query = interpolated.match(tag_values_regex);
  213. if (tag_values_query) {
  214. return this._performMetricKeyValueLookup(tag_values_query[1], tag_values_query[2]).then(responseTransform);
  215. }
  216. var tag_names_suggest_query = interpolated.match(tag_names_suggest_regex);
  217. if (tag_names_suggest_query) {
  218. return this._performSuggestQuery(tag_names_suggest_query[1], 'tagk').then(responseTransform);
  219. }
  220. var tag_values_suggest_query = interpolated.match(tag_values_suggest_regex);
  221. if (tag_values_suggest_query) {
  222. return this._performSuggestQuery(tag_values_suggest_query[1], 'tagv').then(responseTransform);
  223. }
  224. return $q.when([]);
  225. };
  226. this.testDatasource = function() {
  227. return this._performSuggestQuery('cpu', 'metrics').then(function () {
  228. return { status: "success", message: "Data source is working", title: "Success" };
  229. });
  230. };
  231. var aggregatorsPromise = null;
  232. this.getAggregators = function() {
  233. if (aggregatorsPromise) { return aggregatorsPromise; }
  234. aggregatorsPromise = this._get('/api/aggregators').then(function(result) {
  235. if (result.data && _.isArray(result.data)) {
  236. return result.data.sort();
  237. }
  238. return [];
  239. });
  240. return aggregatorsPromise;
  241. };
  242. var filterTypesPromise = null;
  243. this.getFilterTypes = function() {
  244. if (filterTypesPromise) { return filterTypesPromise; }
  245. filterTypesPromise = this._get('/api/config/filters').then(function(result) {
  246. if (result.data) {
  247. return Object.keys(result.data).sort();
  248. }
  249. return [];
  250. });
  251. return filterTypesPromise;
  252. };
  253. function transformMetricData(md, groupByTags, target, options, tsdbResolution) {
  254. var metricLabel = createMetricLabel(md, target, groupByTags, options);
  255. var dps = [];
  256. // TSDB returns datapoints has a hash of ts => value.
  257. // Can't use _.pairs(invert()) because it stringifies keys/values
  258. _.each(md.dps, function (v, k) {
  259. if (tsdbResolution === 2) {
  260. dps.push([v, k * 1]);
  261. } else {
  262. dps.push([v, k * 1000]);
  263. }
  264. });
  265. return { target: metricLabel, datapoints: dps };
  266. }
  267. function createMetricLabel(md, target, groupByTags, options) {
  268. if (target.alias) {
  269. var scopedVars = _.clone(options.scopedVars || {});
  270. _.each(md.tags, function(value, key) {
  271. scopedVars['tag_' + key] = {value: value};
  272. });
  273. return templateSrv.replace(target.alias, scopedVars);
  274. }
  275. var label = md.metric;
  276. var tagData = [];
  277. if (!_.isEmpty(md.tags)) {
  278. _.each(_.pairs(md.tags), function(tag) {
  279. if (_.has(groupByTags, tag[0])) {
  280. tagData.push(tag[0] + "=" + tag[1]);
  281. }
  282. });
  283. }
  284. if (!_.isEmpty(tagData)) {
  285. label += "{" + tagData.join(", ") + "}";
  286. }
  287. return label;
  288. }
  289. function convertTargetToQuery(target, options) {
  290. if (!target.metric || target.hide) {
  291. return null;
  292. }
  293. var query = {
  294. metric: templateSrv.replace(target.metric, options.scopedVars),
  295. aggregator: "avg"
  296. };
  297. if (target.aggregator) {
  298. query.aggregator = templateSrv.replace(target.aggregator);
  299. }
  300. if (target.shouldComputeRate) {
  301. query.rate = true;
  302. query.rateOptions = {
  303. counter: !!target.isCounter
  304. };
  305. if (target.counterMax && target.counterMax.length) {
  306. query.rateOptions.counterMax = parseInt(target.counterMax);
  307. }
  308. if (target.counterResetValue && target.counterResetValue.length) {
  309. query.rateOptions.resetValue = parseInt(target.counterResetValue);
  310. }
  311. }
  312. if (!target.disableDownsampling) {
  313. var interval = templateSrv.replace(target.downsampleInterval || options.interval);
  314. if (interval.match(/\.[0-9]+s/)) {
  315. interval = parseFloat(interval)*1000 + "ms";
  316. }
  317. query.downsample = interval + "-" + target.downsampleAggregator;
  318. if (target.downsampleFillPolicy && target.downsampleFillPolicy !== "none") {
  319. query.downsample += "-" + target.downsampleFillPolicy;
  320. }
  321. }
  322. if (target.filters && target.filters.length > 0) {
  323. query.filters = angular.copy(target.filters);
  324. if(query.filters){
  325. for(var filter_key in query.filters){
  326. query.filters[filter_key].filter = templateSrv.replace(query.filters[filter_key].filter, options.scopedVars, 'pipe');
  327. }
  328. }
  329. } else {
  330. query.tags = angular.copy(target.tags);
  331. if(query.tags){
  332. for(var tag_key in query.tags){
  333. query.tags[tag_key] = templateSrv.replace(query.tags[tag_key], options.scopedVars, 'pipe');
  334. }
  335. }
  336. }
  337. return query;
  338. }
  339. function mapMetricsToTargets(metrics, options, tsdbVersion) {
  340. var interpolatedTagValue;
  341. return _.map(metrics, function(metricData) {
  342. if (tsdbVersion === 3) {
  343. return metricData.query.index;
  344. } else {
  345. return _.findIndex(options.targets, function(target) {
  346. if (target.filters && target.filters.length > 0) {
  347. return target.metric === metricData.metric;
  348. } else {
  349. return target.metric === metricData.metric &&
  350. _.all(target.tags, function(tagV, tagK) {
  351. interpolatedTagValue = templateSrv.replace(tagV, options.scopedVars, 'pipe');
  352. return metricData.tags[tagK] === interpolatedTagValue || interpolatedTagValue === "*";
  353. });
  354. }
  355. });
  356. }
  357. });
  358. }
  359. function convertToTSDBTime(date, roundUp) {
  360. if (date === 'now') {
  361. return null;
  362. }
  363. date = dateMath.parse(date, roundUp);
  364. return date.valueOf();
  365. }
  366. }
  367. return {
  368. OpenTsDatasource: OpenTsDatasource
  369. };
  370. });