datasource.test.ts 39 KB

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