datasource.jest.ts 38 KB

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