datasource.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  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(",");
  144. var key = keysArray[0];
  145. var keysQuery = key + "=*";
  146. if (keysArray.length > 1) {
  147. keysQuery += "," + keysArray.splice(1).join(",");
  148. }
  149. var m = metric + "{" + keysQuery + "}";
  150. return this._get('/api/search/lookup', {m: m, limit: 3000}).then(function(result) {
  151. result = result.data.results;
  152. var tagvs = [];
  153. _.each(result, function(r) {
  154. if (tagvs.indexOf(r.tags[key]) === -1) {
  155. tagvs.push(r.tags[key]);
  156. }
  157. });
  158. return tagvs;
  159. });
  160. };
  161. this._performMetricKeyLookup = function(metric) {
  162. if(!metric) { return $q.when([]); }
  163. return this._get('/api/search/lookup', {m: metric, limit: 1000}).then(function(result) {
  164. result = result.data.results;
  165. var tagks = [];
  166. _.each(result, function(r) {
  167. _.each(r.tags, function(tagv, tagk) {
  168. if(tagks.indexOf(tagk) === -1) {
  169. tagks.push(tagk);
  170. }
  171. });
  172. });
  173. return tagks;
  174. });
  175. };
  176. this._get = function(relativeUrl, params) {
  177. return backendSrv.datasourceRequest({
  178. method: 'GET',
  179. url: this.url + relativeUrl,
  180. params: params,
  181. });
  182. };
  183. this.metricFindQuery = function(query) {
  184. if (!query) { return $q.when([]); }
  185. var interpolated;
  186. try {
  187. interpolated = templateSrv.replace(query);
  188. }
  189. catch (err) {
  190. return $q.reject(err);
  191. }
  192. var responseTransform = function(result) {
  193. return _.map(result, function(value) {
  194. return {text: value};
  195. });
  196. };
  197. var metrics_regex = /metrics\((.*)\)/;
  198. var tag_names_regex = /tag_names\((.*)\)/;
  199. var tag_values_regex = /tag_values\((.*?),\s?(.*)\)/;
  200. var tag_names_suggest_regex = /suggest_tagk\((.*)\)/;
  201. var tag_values_suggest_regex = /suggest_tagv\((.*)\)/;
  202. var metrics_query = interpolated.match(metrics_regex);
  203. if (metrics_query) {
  204. return this._performSuggestQuery(metrics_query[1], 'metrics').then(responseTransform);
  205. }
  206. var tag_names_query = interpolated.match(tag_names_regex);
  207. if (tag_names_query) {
  208. return this._performMetricKeyLookup(tag_names_query[1]).then(responseTransform);
  209. }
  210. var tag_values_query = interpolated.match(tag_values_regex);
  211. if (tag_values_query) {
  212. return this._performMetricKeyValueLookup(tag_values_query[1], tag_values_query[2]).then(responseTransform);
  213. }
  214. var tag_names_suggest_query = interpolated.match(tag_names_suggest_regex);
  215. if (tag_names_suggest_query) {
  216. return this._performSuggestQuery(tag_names_suggest_query[1], 'tagk').then(responseTransform);
  217. }
  218. var tag_values_suggest_query = interpolated.match(tag_values_suggest_regex);
  219. if (tag_values_suggest_query) {
  220. return this._performSuggestQuery(tag_values_suggest_query[1], 'tagv').then(responseTransform);
  221. }
  222. return $q.when([]);
  223. };
  224. this.testDatasource = function() {
  225. return this._performSuggestQuery('cpu', 'metrics').then(function () {
  226. return { status: "success", message: "Data source is working", title: "Success" };
  227. });
  228. };
  229. var aggregatorsPromise = null;
  230. this.getAggregators = function() {
  231. if (aggregatorsPromise) { return aggregatorsPromise; }
  232. aggregatorsPromise = this._get('/api/aggregators').then(function(result) {
  233. if (result.data && _.isArray(result.data)) {
  234. return result.data.sort();
  235. }
  236. return [];
  237. });
  238. return aggregatorsPromise;
  239. };
  240. var filterTypesPromise = null;
  241. this.getFilterTypes = function() {
  242. if (filterTypesPromise) { return filterTypesPromise; }
  243. filterTypesPromise = this._get('/api/config/filters').then(function(result) {
  244. if (result.data) {
  245. return Object.keys(result.data).sort();
  246. }
  247. return [];
  248. });
  249. return filterTypesPromise;
  250. };
  251. function transformMetricData(md, groupByTags, target, options, tsdbResolution) {
  252. var metricLabel = createMetricLabel(md, target, groupByTags, options);
  253. var dps = [];
  254. // TSDB returns datapoints has a hash of ts => value.
  255. // Can't use _.pairs(invert()) because it stringifies keys/values
  256. _.each(md.dps, function (v, k) {
  257. if (tsdbResolution === 2) {
  258. dps.push([v, k * 1]);
  259. } else {
  260. dps.push([v, k * 1000]);
  261. }
  262. });
  263. return { target: metricLabel, datapoints: dps };
  264. }
  265. function createMetricLabel(md, target, groupByTags, options) {
  266. if (target.alias) {
  267. var scopedVars = _.clone(options.scopedVars || {});
  268. _.each(md.tags, function(value, key) {
  269. scopedVars['tag_' + key] = {value: value};
  270. });
  271. return templateSrv.replace(target.alias, scopedVars);
  272. }
  273. var label = md.metric;
  274. var tagData = [];
  275. if (!_.isEmpty(md.tags)) {
  276. _.each(_.pairs(md.tags), function(tag) {
  277. if (_.has(groupByTags, tag[0])) {
  278. tagData.push(tag[0] + "=" + tag[1]);
  279. }
  280. });
  281. }
  282. if (!_.isEmpty(tagData)) {
  283. label += "{" + tagData.join(", ") + "}";
  284. }
  285. return label;
  286. }
  287. function convertTargetToQuery(target, options) {
  288. if (!target.metric || target.hide) {
  289. return null;
  290. }
  291. var query = {
  292. metric: templateSrv.replace(target.metric, options.scopedVars),
  293. aggregator: "avg"
  294. };
  295. if (target.aggregator) {
  296. query.aggregator = templateSrv.replace(target.aggregator);
  297. }
  298. if (target.shouldComputeRate) {
  299. query.rate = true;
  300. query.rateOptions = {
  301. counter: !!target.isCounter
  302. };
  303. if (target.counterMax && target.counterMax.length) {
  304. query.rateOptions.counterMax = parseInt(target.counterMax);
  305. }
  306. if (target.counterResetValue && target.counterResetValue.length) {
  307. query.rateOptions.resetValue = parseInt(target.counterResetValue);
  308. }
  309. }
  310. if (!target.disableDownsampling) {
  311. var interval = templateSrv.replace(target.downsampleInterval || options.interval);
  312. if (interval.match(/\.[0-9]+s/)) {
  313. interval = parseFloat(interval)*1000 + "ms";
  314. }
  315. query.downsample = interval + "-" + target.downsampleAggregator;
  316. if (target.downsampleFillPolicy && target.downsampleFillPolicy !== "none") {
  317. query.downsample += "-" + target.downsampleFillPolicy;
  318. }
  319. }
  320. if (target.filters && target.filters.length > 0) {
  321. query.filters = angular.copy(target.filters);
  322. if(query.filters){
  323. for(var filter_key in query.filters){
  324. query.filters[filter_key].filter = templateSrv.replace(query.filters[filter_key].filter, options.scopedVars, 'pipe');
  325. }
  326. }
  327. } else {
  328. query.tags = angular.copy(target.tags);
  329. if(query.tags){
  330. for(var tag_key in query.tags){
  331. query.tags[tag_key] = templateSrv.replace(query.tags[tag_key], options.scopedVars, 'pipe');
  332. }
  333. }
  334. }
  335. return query;
  336. }
  337. function mapMetricsToTargets(metrics, options, tsdbVersion) {
  338. var interpolatedTagValue;
  339. return _.map(metrics, function(metricData) {
  340. if (tsdbVersion === 3) {
  341. return metricData.query.index;
  342. } else {
  343. return _.findIndex(options.targets, function(target) {
  344. if (target.filters && target.filters.length > 0) {
  345. return target.metric === metricData.metric;
  346. } else {
  347. return target.metric === metricData.metric &&
  348. _.all(target.tags, function(tagV, tagK) {
  349. interpolatedTagValue = templateSrv.replace(tagV, options.scopedVars, 'pipe');
  350. return metricData.tags[tagK] === interpolatedTagValue || interpolatedTagValue === "*";
  351. });
  352. }
  353. });
  354. }
  355. });
  356. }
  357. function convertToTSDBTime(date, roundUp) {
  358. if (date === 'now') {
  359. return null;
  360. }
  361. date = dateMath.parse(date, roundUp);
  362. return date.valueOf();
  363. }
  364. }
  365. return {
  366. OpenTsDatasource: OpenTsDatasource
  367. };
  368. });