datasource.test.ts 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150
  1. import _ from 'lodash';
  2. import moment from 'moment';
  3. import q from 'q';
  4. import {
  5. alignRange,
  6. determineQueryHints,
  7. extractRuleMappingFromGroups,
  8. PrometheusDatasource,
  9. prometheusSpecialRegexEscape,
  10. prometheusRegularEscape,
  11. addLabelToQuery,
  12. } from '../datasource';
  13. jest.mock('../metric_find_query');
  14. describe('PrometheusDatasource', () => {
  15. let ctx: any = {};
  16. let instanceSettings = {
  17. url: 'proxied',
  18. directUrl: 'direct',
  19. user: 'test',
  20. password: 'mupp',
  21. jsonData: {},
  22. };
  23. ctx.backendSrvMock = {};
  24. ctx.templateSrvMock = {
  25. replace: a => a,
  26. };
  27. ctx.timeSrvMock = {
  28. timeRange: () => {
  29. return {
  30. from: moment(1531468681),
  31. to: moment(1531489712),
  32. };
  33. },
  34. };
  35. beforeEach(() => {
  36. ctx.ds = new PrometheusDatasource(instanceSettings, q, ctx.backendSrvMock, ctx.templateSrvMock, ctx.timeSrvMock);
  37. });
  38. describe('Datasource metadata requests', () => {
  39. it('should perform a GET request with the default config', () => {
  40. ctx.backendSrvMock.datasourceRequest = jest.fn();
  41. ctx.ds.metadataRequest('/foo');
  42. expect(ctx.backendSrvMock.datasourceRequest.mock.calls.length).toBe(1);
  43. expect(ctx.backendSrvMock.datasourceRequest.mock.calls[0][0].method).toBe('GET');
  44. });
  45. it('should still perform a GET request with the DS HTTP method set to POST', () => {
  46. ctx.backendSrvMock.datasourceRequest = jest.fn();
  47. const postSettings = _.cloneDeep(instanceSettings);
  48. postSettings.jsonData.httpMethod = 'POST';
  49. const ds = new PrometheusDatasource(postSettings, q, ctx.backendSrvMock, ctx.templateSrvMock, ctx.timeSrvMock);
  50. ds.metadataRequest('/foo');
  51. expect(ctx.backendSrvMock.datasourceRequest.mock.calls.length).toBe(1);
  52. expect(ctx.backendSrvMock.datasourceRequest.mock.calls[0][0].method).toBe('GET');
  53. });
  54. });
  55. describe('When performing performSuggestQuery', () => {
  56. it('should cache response', async () => {
  57. ctx.backendSrvMock.datasourceRequest.mockReturnValue(
  58. Promise.resolve({
  59. status: 'success',
  60. data: { data: ['value1', 'value2', 'value3'] },
  61. })
  62. );
  63. let results = await ctx.ds.performSuggestQuery('value', true);
  64. expect(results).toHaveLength(3);
  65. ctx.backendSrvMock.datasourceRequest.mockReset();
  66. results = await ctx.ds.performSuggestQuery('value', true);
  67. expect(results).toHaveLength(3);
  68. });
  69. });
  70. describe('When converting prometheus histogram to heatmap format', () => {
  71. beforeEach(() => {
  72. ctx.query = {
  73. range: { from: moment(1443454528000), to: moment(1443454528000) },
  74. targets: [{ expr: 'test{job="testjob"}', format: 'heatmap', legendFormat: '{{le}}' }],
  75. interval: '1s',
  76. };
  77. });
  78. it('should convert cumullative histogram to ordinary', () => {
  79. const resultMock = [
  80. {
  81. metric: { __name__: 'metric', job: 'testjob', le: '10' },
  82. values: [[1443454528.0, '10'], [1443454528.0, '10']],
  83. },
  84. {
  85. metric: { __name__: 'metric', job: 'testjob', le: '20' },
  86. values: [[1443454528.0, '20'], [1443454528.0, '10']],
  87. },
  88. {
  89. metric: { __name__: 'metric', job: 'testjob', le: '30' },
  90. values: [[1443454528.0, '25'], [1443454528.0, '10']],
  91. },
  92. ];
  93. const responseMock = { data: { data: { result: resultMock } } };
  94. const expected = [
  95. {
  96. target: '10',
  97. datapoints: [[10, 1443454528000], [10, 1443454528000]],
  98. },
  99. {
  100. target: '20',
  101. datapoints: [[10, 1443454528000], [0, 1443454528000]],
  102. },
  103. {
  104. target: '30',
  105. datapoints: [[5, 1443454528000], [0, 1443454528000]],
  106. },
  107. ];
  108. ctx.ds.performTimeSeriesQuery = jest.fn().mockReturnValue(responseMock);
  109. return ctx.ds.query(ctx.query).then(result => {
  110. let results = result.data;
  111. return expect(results).toMatchObject(expected);
  112. });
  113. });
  114. it('should sort series by label value', () => {
  115. const resultMock = [
  116. {
  117. metric: { __name__: 'metric', job: 'testjob', le: '2' },
  118. values: [[1443454528.0, '10'], [1443454528.0, '10']],
  119. },
  120. {
  121. metric: { __name__: 'metric', job: 'testjob', le: '4' },
  122. values: [[1443454528.0, '20'], [1443454528.0, '10']],
  123. },
  124. {
  125. metric: { __name__: 'metric', job: 'testjob', le: '+Inf' },
  126. values: [[1443454528.0, '25'], [1443454528.0, '10']],
  127. },
  128. {
  129. metric: { __name__: 'metric', job: 'testjob', le: '1' },
  130. values: [[1443454528.0, '25'], [1443454528.0, '10']],
  131. },
  132. ];
  133. const responseMock = { data: { data: { result: resultMock } } };
  134. const expected = ['1', '2', '4', '+Inf'];
  135. ctx.ds.performTimeSeriesQuery = jest.fn().mockReturnValue(responseMock);
  136. return ctx.ds.query(ctx.query).then(result => {
  137. let seriesLabels = _.map(result.data, 'target');
  138. return expect(seriesLabels).toEqual(expected);
  139. });
  140. });
  141. });
  142. describe('alignRange', () => {
  143. it('does not modify already aligned intervals with perfect step', () => {
  144. const range = alignRange(0, 3, 3);
  145. expect(range.start).toEqual(0);
  146. expect(range.end).toEqual(3);
  147. });
  148. it('does modify end-aligned intervals to reflect number of steps possible', () => {
  149. const range = alignRange(1, 6, 3);
  150. expect(range.start).toEqual(0);
  151. expect(range.end).toEqual(6);
  152. });
  153. it('does align intervals that are a multiple of steps', () => {
  154. const range = alignRange(1, 4, 3);
  155. expect(range.start).toEqual(0);
  156. expect(range.end).toEqual(6);
  157. });
  158. it('does align intervals that are not a multiple of steps', () => {
  159. const range = alignRange(1, 5, 3);
  160. expect(range.start).toEqual(0);
  161. expect(range.end).toEqual(6);
  162. });
  163. });
  164. describe('determineQueryHints()', () => {
  165. it('returns no hints for no series', () => {
  166. expect(determineQueryHints([])).toEqual([]);
  167. });
  168. it('returns no hints for empty series', () => {
  169. expect(determineQueryHints([{ datapoints: [], query: '' }])).toEqual([null]);
  170. });
  171. it('returns no hint for a monotonously decreasing series', () => {
  172. const series = [{ datapoints: [[23, 1000], [22, 1001]], query: 'metric', responseIndex: 0 }];
  173. const hints = determineQueryHints(series);
  174. expect(hints).toEqual([null]);
  175. });
  176. it('returns a rate hint for a monotonously increasing series', () => {
  177. const series = [{ datapoints: [[23, 1000], [24, 1001]], query: 'metric', responseIndex: 0 }];
  178. const hints = determineQueryHints(series);
  179. expect(hints.length).toBe(1);
  180. expect(hints[0]).toMatchObject({
  181. label: 'Time series is monotonously increasing.',
  182. index: 0,
  183. fix: {
  184. action: {
  185. type: 'ADD_RATE',
  186. query: 'metric',
  187. },
  188. },
  189. });
  190. });
  191. it('returns a histogram hint for a bucket series', () => {
  192. const series = [{ datapoints: [[23, 1000]], query: 'metric_bucket', responseIndex: 0 }];
  193. const hints = determineQueryHints(series);
  194. expect(hints.length).toBe(1);
  195. expect(hints[0]).toMatchObject({
  196. label: 'Time series has buckets, you probably wanted a histogram.',
  197. index: 0,
  198. fix: {
  199. action: {
  200. type: 'ADD_HISTOGRAM_QUANTILE',
  201. query: 'metric_bucket',
  202. },
  203. },
  204. });
  205. });
  206. });
  207. describe('extractRuleMappingFromGroups()', () => {
  208. it('returns empty mapping for no rule groups', () => {
  209. expect(extractRuleMappingFromGroups([])).toEqual({});
  210. });
  211. it('returns a mapping for recording rules only', () => {
  212. const groups = [
  213. {
  214. rules: [
  215. {
  216. name: 'HighRequestLatency',
  217. query: 'job:request_latency_seconds:mean5m{job="myjob"} > 0.5',
  218. type: 'alerting',
  219. },
  220. {
  221. name: 'job:http_inprogress_requests:sum',
  222. query: 'sum(http_inprogress_requests) by (job)',
  223. type: 'recording',
  224. },
  225. ],
  226. file: '/rules.yaml',
  227. interval: 60,
  228. name: 'example',
  229. },
  230. ];
  231. const mapping = extractRuleMappingFromGroups(groups);
  232. expect(mapping).toEqual({ 'job:http_inprogress_requests:sum': 'sum(http_inprogress_requests) by (job)' });
  233. });
  234. });
  235. describe('Prometheus regular escaping', () => {
  236. it('should not escape non-string', () => {
  237. expect(prometheusRegularEscape(12)).toEqual(12);
  238. });
  239. it('should not escape simple string', () => {
  240. expect(prometheusRegularEscape('cryptodepression')).toEqual('cryptodepression');
  241. });
  242. it("should escape '", () => {
  243. expect(prometheusRegularEscape("looking'glass")).toEqual("looking\\\\'glass");
  244. });
  245. it('should escape multiple characters', () => {
  246. expect(prometheusRegularEscape("'looking'glass'")).toEqual("\\\\'looking\\\\'glass\\\\'");
  247. });
  248. });
  249. describe('Prometheus regexes escaping', () => {
  250. it('should not escape simple string', () => {
  251. expect(prometheusSpecialRegexEscape('cryptodepression')).toEqual('cryptodepression');
  252. });
  253. it('should escape $^*+?.()\\', () => {
  254. expect(prometheusSpecialRegexEscape("looking'glass")).toEqual("looking\\\\'glass");
  255. expect(prometheusSpecialRegexEscape('looking{glass')).toEqual('looking\\\\{glass');
  256. expect(prometheusSpecialRegexEscape('looking}glass')).toEqual('looking\\\\}glass');
  257. expect(prometheusSpecialRegexEscape('looking[glass')).toEqual('looking\\\\[glass');
  258. expect(prometheusSpecialRegexEscape('looking]glass')).toEqual('looking\\\\]glass');
  259. expect(prometheusSpecialRegexEscape('looking$glass')).toEqual('looking\\\\$glass');
  260. expect(prometheusSpecialRegexEscape('looking^glass')).toEqual('looking\\\\^glass');
  261. expect(prometheusSpecialRegexEscape('looking*glass')).toEqual('looking\\\\*glass');
  262. expect(prometheusSpecialRegexEscape('looking+glass')).toEqual('looking\\\\+glass');
  263. expect(prometheusSpecialRegexEscape('looking?glass')).toEqual('looking\\\\?glass');
  264. expect(prometheusSpecialRegexEscape('looking.glass')).toEqual('looking\\\\.glass');
  265. expect(prometheusSpecialRegexEscape('looking(glass')).toEqual('looking\\\\(glass');
  266. expect(prometheusSpecialRegexEscape('looking)glass')).toEqual('looking\\\\)glass');
  267. expect(prometheusSpecialRegexEscape('looking\\glass')).toEqual('looking\\\\\\\\glass');
  268. });
  269. it('should escape multiple special characters', () => {
  270. expect(prometheusSpecialRegexEscape('+looking$glass?')).toEqual('\\\\+looking\\\\$glass\\\\?');
  271. });
  272. });
  273. describe('metricFindQuery', () => {
  274. beforeEach(() => {
  275. let query = 'query_result(topk(5,rate(http_request_duration_microseconds_count[$__interval])))';
  276. ctx.templateSrvMock.replace = jest.fn();
  277. ctx.timeSrvMock.timeRange = () => {
  278. return {
  279. from: moment(1531468681),
  280. to: moment(1531489712),
  281. };
  282. };
  283. ctx.ds = new PrometheusDatasource(instanceSettings, q, ctx.backendSrvMock, ctx.templateSrvMock, ctx.timeSrvMock);
  284. ctx.ds.metricFindQuery(query);
  285. });
  286. it('should call templateSrv.replace with scopedVars', () => {
  287. expect(ctx.templateSrvMock.replace.mock.calls[0][1]).toBeDefined();
  288. });
  289. it('should have the correct range and range_ms', () => {
  290. let range = ctx.templateSrvMock.replace.mock.calls[0][1].__range;
  291. let rangeMs = ctx.templateSrvMock.replace.mock.calls[0][1].__range_ms;
  292. let rangeS = ctx.templateSrvMock.replace.mock.calls[0][1].__range_s;
  293. expect(range).toEqual({ text: '21s', value: '21s' });
  294. expect(rangeMs).toEqual({ text: 21031, value: 21031 });
  295. expect(rangeS).toEqual({ text: 21, value: 21 });
  296. });
  297. it('should pass the default interval value', () => {
  298. let interval = ctx.templateSrvMock.replace.mock.calls[0][1].__interval;
  299. let intervalMs = ctx.templateSrvMock.replace.mock.calls[0][1].__interval_ms;
  300. expect(interval).toEqual({ text: '15s', value: '15s' });
  301. expect(intervalMs).toEqual({ text: 15000, value: 15000 });
  302. });
  303. });
  304. describe('addLabelToQuery()', () => {
  305. expect(() => {
  306. addLabelToQuery('foo', '', '');
  307. }).toThrow();
  308. expect(addLabelToQuery('foo + foo', 'bar', 'baz')).toBe('foo{bar="baz"} + foo{bar="baz"}');
  309. expect(addLabelToQuery('foo{}', 'bar', 'baz')).toBe('foo{bar="baz"}');
  310. expect(addLabelToQuery('foo{x="yy"}', 'bar', 'baz')).toBe('foo{bar="baz",x="yy"}');
  311. expect(addLabelToQuery('foo{x="yy"} + metric', 'bar', 'baz')).toBe('foo{bar="baz",x="yy"} + metric{bar="baz"}');
  312. expect(addLabelToQuery('avg(foo) + sum(xx_yy)', 'bar', 'baz')).toBe('avg(foo{bar="baz"}) + sum(xx_yy{bar="baz"})');
  313. expect(addLabelToQuery('foo{x="yy"} * metric{y="zz",a="bb"} * metric2', 'bar', 'baz')).toBe(
  314. 'foo{bar="baz",x="yy"} * metric{a="bb",bar="baz",y="zz"} * metric2{bar="baz"}'
  315. );
  316. expect(addLabelToQuery('sum by (xx) (foo)', 'bar', 'baz')).toBe('sum by (xx) (foo{bar="baz"})');
  317. expect(addLabelToQuery('foo{instance="my-host.com:9100"}', 'bar', 'baz')).toBe(
  318. 'foo{bar="baz",instance="my-host.com:9100"}'
  319. );
  320. expect(addLabelToQuery('rate(metric[1m])', 'foo', 'bar')).toBe('rate(metric{foo="bar"}[1m])');
  321. });
  322. });
  323. const SECOND = 1000;
  324. const MINUTE = 60 * SECOND;
  325. const HOUR = 60 * MINUTE;
  326. const time = ({ hours = 0, seconds = 0, minutes = 0 }) => moment(hours * HOUR + minutes * MINUTE + seconds * SECOND);
  327. let ctx = <any>{};
  328. let instanceSettings = {
  329. url: 'proxied',
  330. directUrl: 'direct',
  331. user: 'test',
  332. password: 'mupp',
  333. jsonData: { httpMethod: 'GET' },
  334. };
  335. let backendSrv = <any>{
  336. datasourceRequest: jest.fn(),
  337. };
  338. let templateSrv = {
  339. replace: jest.fn(str => str),
  340. };
  341. let timeSrv = {
  342. timeRange: () => {
  343. return { to: { diff: () => 2000 }, from: '' };
  344. },
  345. };
  346. describe('PrometheusDatasource', () => {
  347. describe('When querying prometheus with one target using query editor target spec', async () => {
  348. var results;
  349. var query = {
  350. range: { from: time({ seconds: 63 }), to: time({ seconds: 183 }) },
  351. targets: [{ expr: 'test{job="testjob"}', format: 'time_series' }],
  352. interval: '60s',
  353. };
  354. // Interval alignment with step
  355. var urlExpected =
  356. 'proxied/api/v1/query_range?query=' + encodeURIComponent('test{job="testjob"}') + '&start=60&end=240&step=60';
  357. beforeEach(async () => {
  358. let response = {
  359. data: {
  360. status: 'success',
  361. data: {
  362. resultType: 'matrix',
  363. result: [
  364. {
  365. metric: { __name__: 'test', job: 'testjob' },
  366. values: [[60, '3846']],
  367. },
  368. ],
  369. },
  370. },
  371. };
  372. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  373. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  374. await ctx.ds.query(query).then(function(data) {
  375. results = data;
  376. });
  377. });
  378. it('should generate the correct query', () => {
  379. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  380. expect(res.method).toBe('GET');
  381. expect(res.url).toBe(urlExpected);
  382. });
  383. it('should return series list', async () => {
  384. expect(results.data.length).toBe(1);
  385. expect(results.data[0].target).toBe('test{job="testjob"}');
  386. });
  387. });
  388. describe('When querying prometheus with one target which return multiple series', () => {
  389. var results;
  390. var start = 60;
  391. var end = 360;
  392. var step = 60;
  393. var query = {
  394. range: { from: time({ seconds: start }), to: time({ seconds: end }) },
  395. targets: [{ expr: 'test{job="testjob"}', format: 'time_series' }],
  396. interval: '60s',
  397. };
  398. beforeEach(async () => {
  399. let response = {
  400. status: 'success',
  401. data: {
  402. data: {
  403. resultType: 'matrix',
  404. result: [
  405. {
  406. metric: { __name__: 'test', job: 'testjob', series: 'series 1' },
  407. values: [[start + step * 1, '3846'], [start + step * 3, '3847'], [end - step * 1, '3848']],
  408. },
  409. {
  410. metric: { __name__: 'test', job: 'testjob', series: 'series 2' },
  411. values: [[start + step * 2, '4846']],
  412. },
  413. ],
  414. },
  415. },
  416. };
  417. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  418. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  419. await ctx.ds.query(query).then(function(data) {
  420. results = data;
  421. });
  422. });
  423. it('should be same length', () => {
  424. expect(results.data.length).toBe(2);
  425. expect(results.data[0].datapoints.length).toBe((end - start) / step + 1);
  426. expect(results.data[1].datapoints.length).toBe((end - start) / step + 1);
  427. });
  428. it('should fill null until first datapoint in response', () => {
  429. expect(results.data[0].datapoints[0][1]).toBe(start * 1000);
  430. expect(results.data[0].datapoints[0][0]).toBe(null);
  431. expect(results.data[0].datapoints[1][1]).toBe((start + step * 1) * 1000);
  432. expect(results.data[0].datapoints[1][0]).toBe(3846);
  433. });
  434. it('should fill null after last datapoint in response', () => {
  435. var length = (end - start) / step + 1;
  436. expect(results.data[0].datapoints[length - 2][1]).toBe((end - step * 1) * 1000);
  437. expect(results.data[0].datapoints[length - 2][0]).toBe(3848);
  438. expect(results.data[0].datapoints[length - 1][1]).toBe(end * 1000);
  439. expect(results.data[0].datapoints[length - 1][0]).toBe(null);
  440. });
  441. it('should fill null at gap between series', () => {
  442. expect(results.data[0].datapoints[2][1]).toBe((start + step * 2) * 1000);
  443. expect(results.data[0].datapoints[2][0]).toBe(null);
  444. expect(results.data[1].datapoints[1][1]).toBe((start + step * 1) * 1000);
  445. expect(results.data[1].datapoints[1][0]).toBe(null);
  446. expect(results.data[1].datapoints[3][1]).toBe((start + step * 3) * 1000);
  447. expect(results.data[1].datapoints[3][0]).toBe(null);
  448. });
  449. });
  450. describe('When querying prometheus with one target and instant = true', () => {
  451. var results;
  452. var urlExpected = 'proxied/api/v1/query?query=' + encodeURIComponent('test{job="testjob"}') + '&time=123';
  453. var query = {
  454. range: { from: time({ seconds: 63 }), to: time({ seconds: 123 }) },
  455. targets: [{ expr: 'test{job="testjob"}', format: 'time_series', instant: true }],
  456. interval: '60s',
  457. };
  458. beforeEach(async () => {
  459. let response = {
  460. status: 'success',
  461. data: {
  462. data: {
  463. resultType: 'vector',
  464. result: [
  465. {
  466. metric: { __name__: 'test', job: 'testjob' },
  467. value: [123, '3846'],
  468. },
  469. ],
  470. },
  471. },
  472. };
  473. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  474. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  475. await ctx.ds.query(query).then(function(data) {
  476. results = data;
  477. });
  478. });
  479. it('should generate the correct query', () => {
  480. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  481. expect(res.method).toBe('GET');
  482. expect(res.url).toBe(urlExpected);
  483. });
  484. it('should return series list', () => {
  485. expect(results.data.length).toBe(1);
  486. expect(results.data[0].target).toBe('test{job="testjob"}');
  487. });
  488. });
  489. describe('When performing annotationQuery', () => {
  490. var results;
  491. var options = {
  492. annotation: {
  493. expr: 'ALERTS{alertstate="firing"}',
  494. tagKeys: 'job',
  495. titleFormat: '{{alertname}}',
  496. textFormat: '{{instance}}',
  497. },
  498. range: {
  499. from: time({ seconds: 63 }),
  500. to: time({ seconds: 123 }),
  501. },
  502. };
  503. beforeEach(async () => {
  504. let response = {
  505. status: 'success',
  506. data: {
  507. data: {
  508. resultType: 'matrix',
  509. result: [
  510. {
  511. metric: {
  512. __name__: 'ALERTS',
  513. alertname: 'InstanceDown',
  514. alertstate: 'firing',
  515. instance: 'testinstance',
  516. job: 'testjob',
  517. },
  518. values: [[123, '1']],
  519. },
  520. ],
  521. },
  522. },
  523. };
  524. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  525. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  526. await ctx.ds.annotationQuery(options).then(function(data) {
  527. results = data;
  528. });
  529. });
  530. it('should return annotation list', () => {
  531. expect(results.length).toBe(1);
  532. expect(results[0].tags).toContain('testjob');
  533. expect(results[0].title).toBe('InstanceDown');
  534. expect(results[0].text).toBe('testinstance');
  535. expect(results[0].time).toBe(123 * 1000);
  536. });
  537. });
  538. describe('When resultFormat is table and instant = true', () => {
  539. var results;
  540. var query = {
  541. range: { from: time({ seconds: 63 }), to: time({ seconds: 123 }) },
  542. targets: [{ expr: 'test{job="testjob"}', format: 'time_series', instant: true }],
  543. interval: '60s',
  544. };
  545. beforeEach(async () => {
  546. let response = {
  547. status: 'success',
  548. data: {
  549. data: {
  550. resultType: 'vector',
  551. result: [
  552. {
  553. metric: { __name__: 'test', job: 'testjob' },
  554. value: [123, '3846'],
  555. },
  556. ],
  557. },
  558. },
  559. };
  560. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  561. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  562. await ctx.ds.query(query).then(function(data) {
  563. results = data;
  564. });
  565. });
  566. it('should return result', () => {
  567. expect(results).not.toBe(null);
  568. });
  569. });
  570. describe('The "step" query parameter', () => {
  571. var response = {
  572. status: 'success',
  573. data: {
  574. data: {
  575. resultType: 'matrix',
  576. result: [],
  577. },
  578. },
  579. };
  580. it('should be min interval when greater than auto interval', async () => {
  581. let query = {
  582. // 6 minute range
  583. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  584. targets: [
  585. {
  586. expr: 'test',
  587. interval: '10s',
  588. },
  589. ],
  590. interval: '5s',
  591. };
  592. let urlExpected = 'proxied/api/v1/query_range?query=test&start=60&end=420&step=10';
  593. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  594. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  595. await ctx.ds.query(query);
  596. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  597. expect(res.method).toBe('GET');
  598. expect(res.url).toBe(urlExpected);
  599. });
  600. it('step should never go below 1', async () => {
  601. var query = {
  602. // 6 minute range
  603. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  604. targets: [{ expr: 'test' }],
  605. interval: '100ms',
  606. };
  607. var urlExpected = 'proxied/api/v1/query_range?query=test&start=60&end=420&step=1';
  608. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  609. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  610. await ctx.ds.query(query);
  611. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  612. expect(res.method).toBe('GET');
  613. expect(res.url).toBe(urlExpected);
  614. });
  615. it('should be auto interval when greater than min interval', async () => {
  616. var query = {
  617. // 6 minute range
  618. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  619. targets: [
  620. {
  621. expr: 'test',
  622. interval: '5s',
  623. },
  624. ],
  625. interval: '10s',
  626. };
  627. var urlExpected = 'proxied/api/v1/query_range?query=test&start=60&end=420&step=10';
  628. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  629. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  630. await ctx.ds.query(query);
  631. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  632. expect(res.method).toBe('GET');
  633. expect(res.url).toBe(urlExpected);
  634. });
  635. it('should result in querying fewer than 11000 data points', async () => {
  636. var query = {
  637. // 6 hour range
  638. range: { from: time({ hours: 1 }), to: time({ hours: 7 }) },
  639. targets: [{ expr: 'test' }],
  640. interval: '1s',
  641. };
  642. var end = 7 * 60 * 60;
  643. var start = 60 * 60;
  644. var urlExpected = 'proxied/api/v1/query_range?query=test&start=' + start + '&end=' + end + '&step=2';
  645. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  646. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  647. await ctx.ds.query(query);
  648. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  649. expect(res.method).toBe('GET');
  650. expect(res.url).toBe(urlExpected);
  651. });
  652. it('should not apply min interval when interval * intervalFactor greater', async () => {
  653. var query = {
  654. // 6 minute range
  655. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  656. targets: [
  657. {
  658. expr: 'test',
  659. interval: '10s',
  660. intervalFactor: 10,
  661. },
  662. ],
  663. interval: '5s',
  664. };
  665. // times get rounded up to interval
  666. var urlExpected = 'proxied/api/v1/query_range?query=test&start=50&end=450&step=50';
  667. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  668. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  669. await ctx.ds.query(query);
  670. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  671. expect(res.method).toBe('GET');
  672. expect(res.url).toBe(urlExpected);
  673. });
  674. it('should apply min interval when interval * intervalFactor smaller', async () => {
  675. var query = {
  676. // 6 minute range
  677. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  678. targets: [
  679. {
  680. expr: 'test',
  681. interval: '15s',
  682. intervalFactor: 2,
  683. },
  684. ],
  685. interval: '5s',
  686. };
  687. var urlExpected = 'proxied/api/v1/query_range?query=test' + '&start=60&end=420&step=15';
  688. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  689. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  690. await ctx.ds.query(query);
  691. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  692. expect(res.method).toBe('GET');
  693. expect(res.url).toBe(urlExpected);
  694. });
  695. it('should apply intervalFactor to auto interval when greater', async () => {
  696. var query = {
  697. // 6 minute range
  698. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  699. targets: [
  700. {
  701. expr: 'test',
  702. interval: '5s',
  703. intervalFactor: 10,
  704. },
  705. ],
  706. interval: '10s',
  707. };
  708. // times get aligned to interval
  709. var urlExpected = 'proxied/api/v1/query_range?query=test' + '&start=0&end=500&step=100';
  710. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  711. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  712. await ctx.ds.query(query);
  713. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  714. expect(res.method).toBe('GET');
  715. expect(res.url).toBe(urlExpected);
  716. });
  717. it('should not not be affected by the 11000 data points limit when large enough', async () => {
  718. var query = {
  719. // 1 week range
  720. range: { from: time({}), to: time({ hours: 7 * 24 }) },
  721. targets: [
  722. {
  723. expr: 'test',
  724. intervalFactor: 10,
  725. },
  726. ],
  727. interval: '10s',
  728. };
  729. var end = 7 * 24 * 60 * 60;
  730. var start = 0;
  731. var urlExpected = 'proxied/api/v1/query_range?query=test' + '&start=' + start + '&end=' + end + '&step=100';
  732. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  733. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  734. await ctx.ds.query(query);
  735. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  736. expect(res.method).toBe('GET');
  737. expect(res.url).toBe(urlExpected);
  738. });
  739. it('should be determined by the 11000 data points limit when too small', async () => {
  740. var query = {
  741. // 1 week range
  742. range: { from: time({}), to: time({ hours: 7 * 24 }) },
  743. targets: [
  744. {
  745. expr: 'test',
  746. intervalFactor: 10,
  747. },
  748. ],
  749. interval: '5s',
  750. };
  751. var end = 7 * 24 * 60 * 60;
  752. var start = 0;
  753. var urlExpected = 'proxied/api/v1/query_range?query=test' + '&start=' + start + '&end=' + end + '&step=60';
  754. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  755. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  756. await ctx.ds.query(query);
  757. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  758. expect(res.method).toBe('GET');
  759. expect(res.url).toBe(urlExpected);
  760. });
  761. });
  762. describe('The __interval and __interval_ms template variables', () => {
  763. var response = {
  764. status: 'success',
  765. data: {
  766. data: {
  767. resultType: 'matrix',
  768. result: [],
  769. },
  770. },
  771. };
  772. it('should be unchanged when auto interval is greater than min interval', async () => {
  773. var query = {
  774. // 6 minute range
  775. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  776. targets: [
  777. {
  778. expr: 'rate(test[$__interval])',
  779. interval: '5s',
  780. },
  781. ],
  782. interval: '10s',
  783. scopedVars: {
  784. __interval: { text: '10s', value: '10s' },
  785. __interval_ms: { text: 10 * 1000, value: 10 * 1000 },
  786. },
  787. };
  788. var urlExpected =
  789. 'proxied/api/v1/query_range?query=' +
  790. encodeURIComponent('rate(test[$__interval])') +
  791. '&start=60&end=420&step=10';
  792. templateSrv.replace = jest.fn(str => str);
  793. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  794. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  795. await ctx.ds.query(query);
  796. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  797. expect(res.method).toBe('GET');
  798. expect(res.url).toBe(urlExpected);
  799. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  800. __interval: {
  801. text: '10s',
  802. value: '10s',
  803. },
  804. __interval_ms: {
  805. text: 10000,
  806. value: 10000,
  807. },
  808. });
  809. });
  810. it('should be min interval when it is greater than auto interval', async () => {
  811. var query = {
  812. // 6 minute range
  813. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  814. targets: [
  815. {
  816. expr: 'rate(test[$__interval])',
  817. interval: '10s',
  818. },
  819. ],
  820. interval: '5s',
  821. scopedVars: {
  822. __interval: { text: '5s', value: '5s' },
  823. __interval_ms: { text: 5 * 1000, value: 5 * 1000 },
  824. },
  825. };
  826. var urlExpected =
  827. 'proxied/api/v1/query_range?query=' +
  828. encodeURIComponent('rate(test[$__interval])') +
  829. '&start=60&end=420&step=10';
  830. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  831. templateSrv.replace = jest.fn(str => str);
  832. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  833. await ctx.ds.query(query);
  834. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  835. expect(res.method).toBe('GET');
  836. expect(res.url).toBe(urlExpected);
  837. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  838. __interval: {
  839. text: '5s',
  840. value: '5s',
  841. },
  842. __interval_ms: {
  843. text: 5000,
  844. value: 5000,
  845. },
  846. });
  847. });
  848. it('should account for intervalFactor', async () => {
  849. var query = {
  850. // 6 minute range
  851. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  852. targets: [
  853. {
  854. expr: 'rate(test[$__interval])',
  855. interval: '5s',
  856. intervalFactor: 10,
  857. },
  858. ],
  859. interval: '10s',
  860. scopedVars: {
  861. __interval: { text: '10s', value: '10s' },
  862. __interval_ms: { text: 10 * 1000, value: 10 * 1000 },
  863. },
  864. };
  865. var urlExpected =
  866. 'proxied/api/v1/query_range?query=' +
  867. encodeURIComponent('rate(test[$__interval])') +
  868. '&start=0&end=500&step=100';
  869. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  870. templateSrv.replace = jest.fn(str => str);
  871. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  872. await ctx.ds.query(query);
  873. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  874. expect(res.method).toBe('GET');
  875. expect(res.url).toBe(urlExpected);
  876. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  877. __interval: {
  878. text: '10s',
  879. value: '10s',
  880. },
  881. __interval_ms: {
  882. text: 10000,
  883. value: 10000,
  884. },
  885. });
  886. expect(query.scopedVars.__interval.text).toBe('10s');
  887. expect(query.scopedVars.__interval.value).toBe('10s');
  888. expect(query.scopedVars.__interval_ms.text).toBe(10 * 1000);
  889. expect(query.scopedVars.__interval_ms.value).toBe(10 * 1000);
  890. });
  891. it('should be interval * intervalFactor when greater than min interval', async () => {
  892. var query = {
  893. // 6 minute range
  894. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  895. targets: [
  896. {
  897. expr: 'rate(test[$__interval])',
  898. interval: '10s',
  899. intervalFactor: 10,
  900. },
  901. ],
  902. interval: '5s',
  903. scopedVars: {
  904. __interval: { text: '5s', value: '5s' },
  905. __interval_ms: { text: 5 * 1000, value: 5 * 1000 },
  906. },
  907. };
  908. var urlExpected =
  909. 'proxied/api/v1/query_range?query=' +
  910. encodeURIComponent('rate(test[$__interval])') +
  911. '&start=50&end=450&step=50';
  912. templateSrv.replace = jest.fn(str => str);
  913. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  914. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  915. await ctx.ds.query(query);
  916. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  917. expect(res.method).toBe('GET');
  918. expect(res.url).toBe(urlExpected);
  919. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  920. __interval: {
  921. text: '5s',
  922. value: '5s',
  923. },
  924. __interval_ms: {
  925. text: 5000,
  926. value: 5000,
  927. },
  928. });
  929. });
  930. it('should be min interval when greater than interval * intervalFactor', async () => {
  931. var query = {
  932. // 6 minute range
  933. range: { from: time({ minutes: 1 }), to: time({ minutes: 7 }) },
  934. targets: [
  935. {
  936. expr: 'rate(test[$__interval])',
  937. interval: '15s',
  938. intervalFactor: 2,
  939. },
  940. ],
  941. interval: '5s',
  942. scopedVars: {
  943. __interval: { text: '5s', value: '5s' },
  944. __interval_ms: { text: 5 * 1000, value: 5 * 1000 },
  945. },
  946. };
  947. var urlExpected =
  948. 'proxied/api/v1/query_range?query=' +
  949. encodeURIComponent('rate(test[$__interval])') +
  950. '&start=60&end=420&step=15';
  951. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  952. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  953. await ctx.ds.query(query);
  954. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  955. expect(res.method).toBe('GET');
  956. expect(res.url).toBe(urlExpected);
  957. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  958. __interval: {
  959. text: '5s',
  960. value: '5s',
  961. },
  962. __interval_ms: {
  963. text: 5000,
  964. value: 5000,
  965. },
  966. });
  967. });
  968. it('should be determined by the 11000 data points limit, accounting for intervalFactor', async () => {
  969. var query = {
  970. // 1 week range
  971. range: { from: time({}), to: time({ hours: 7 * 24 }) },
  972. targets: [
  973. {
  974. expr: 'rate(test[$__interval])',
  975. intervalFactor: 10,
  976. },
  977. ],
  978. interval: '5s',
  979. scopedVars: {
  980. __interval: { text: '5s', value: '5s' },
  981. __interval_ms: { text: 5 * 1000, value: 5 * 1000 },
  982. },
  983. };
  984. var end = 7 * 24 * 60 * 60;
  985. var start = 0;
  986. var urlExpected =
  987. 'proxied/api/v1/query_range?query=' +
  988. encodeURIComponent('rate(test[$__interval])') +
  989. '&start=' +
  990. start +
  991. '&end=' +
  992. end +
  993. '&step=60';
  994. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  995. templateSrv.replace = jest.fn(str => str);
  996. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  997. await ctx.ds.query(query);
  998. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  999. expect(res.method).toBe('GET');
  1000. expect(res.url).toBe(urlExpected);
  1001. expect(templateSrv.replace.mock.calls[0][1]).toEqual({
  1002. __interval: {
  1003. text: '5s',
  1004. value: '5s',
  1005. },
  1006. __interval_ms: {
  1007. text: 5000,
  1008. value: 5000,
  1009. },
  1010. });
  1011. });
  1012. });
  1013. });
  1014. describe('PrometheusDatasource for POST', () => {
  1015. // var ctx = new helpers.ServiceTestContext();
  1016. let instanceSettings = {
  1017. url: 'proxied',
  1018. directUrl: 'direct',
  1019. user: 'test',
  1020. password: 'mupp',
  1021. jsonData: { httpMethod: 'POST' },
  1022. };
  1023. describe('When querying prometheus with one target using query editor target spec', () => {
  1024. var results;
  1025. var urlExpected = 'proxied/api/v1/query_range';
  1026. var dataExpected = {
  1027. query: 'test{job="testjob"}',
  1028. start: 1 * 60,
  1029. end: 3 * 60,
  1030. step: 60,
  1031. };
  1032. var query = {
  1033. range: { from: time({ minutes: 1, seconds: 3 }), to: time({ minutes: 2, seconds: 3 }) },
  1034. targets: [{ expr: 'test{job="testjob"}', format: 'time_series' }],
  1035. interval: '60s',
  1036. };
  1037. beforeEach(async () => {
  1038. let response = {
  1039. status: 'success',
  1040. data: {
  1041. data: {
  1042. resultType: 'matrix',
  1043. result: [
  1044. {
  1045. metric: { __name__: 'test', job: 'testjob' },
  1046. values: [[2 * 60, '3846']],
  1047. },
  1048. ],
  1049. },
  1050. },
  1051. };
  1052. backendSrv.datasourceRequest = jest.fn(() => Promise.resolve(response));
  1053. ctx.ds = new PrometheusDatasource(instanceSettings, q, <any>backendSrv, templateSrv, timeSrv);
  1054. await ctx.ds.query(query).then(function(data) {
  1055. results = data;
  1056. });
  1057. });
  1058. it('should generate the correct query', () => {
  1059. let res = backendSrv.datasourceRequest.mock.calls[0][0];
  1060. expect(res.method).toBe('POST');
  1061. expect(res.url).toBe(urlExpected);
  1062. expect(res.data).toEqual(dataExpected);
  1063. });
  1064. it('should return series list', () => {
  1065. expect(results.data.length).toBe(1);
  1066. expect(results.data[0].target).toBe('test{job="testjob"}');
  1067. });
  1068. });
  1069. });