query_builder_specs.ts 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. import {describe, beforeEach, it, sinon, expect} from 'test/lib/common';
  2. import ElasticQueryBuilder from '../query_builder';
  3. describe('ElasticQueryBuilder', function() {
  4. var builder;
  5. beforeEach(function() {
  6. builder = new ElasticQueryBuilder({timeField: '@timestamp'});
  7. });
  8. it('with defaults', function() {
  9. var query = builder.build({
  10. metrics: [{type: 'Count', id: '0'}],
  11. timeField: '@timestamp',
  12. bucketAggs: [{type: 'date_histogram', field: '@timestamp', id: '1'}],
  13. });
  14. expect(query.query.bool.filter[0].range["@timestamp"].gte).to.be("$timeFrom");
  15. expect(query.aggs["1"].date_histogram.extended_bounds.min).to.be("$timeFrom");
  16. });
  17. it('with defaults on es5.x', function() {
  18. var builder_5x = new ElasticQueryBuilder({
  19. timeField: '@timestamp',
  20. esVersion: 5
  21. });
  22. var query = builder_5x.build({
  23. metrics: [{type: 'Count', id: '0'}],
  24. timeField: '@timestamp',
  25. bucketAggs: [{type: 'date_histogram', field: '@timestamp', id: '1'}],
  26. });
  27. expect(query.query.bool.filter[0].range["@timestamp"].gte).to.be("$timeFrom");
  28. expect(query.aggs["1"].date_histogram.extended_bounds.min).to.be("$timeFrom");
  29. });
  30. it('with multiple bucket aggs', function() {
  31. var query = builder.build({
  32. metrics: [{type: 'count', id: '1'}],
  33. timeField: '@timestamp',
  34. bucketAggs: [
  35. {type: 'terms', field: '@host', id: '2'},
  36. {type: 'date_histogram', field: '@timestamp', id: '3'}
  37. ],
  38. });
  39. expect(query.aggs["2"].terms.field).to.be("@host");
  40. expect(query.aggs["2"].aggs["3"].date_histogram.field).to.be("@timestamp");
  41. });
  42. it('with select field', function() {
  43. var query = builder.build({
  44. metrics: [{type: 'avg', field: '@value', id: '1'}],
  45. bucketAggs: [{type: 'date_histogram', field: '@timestamp', id: '2'}],
  46. }, 100, 1000);
  47. var aggs = query.aggs["2"].aggs;
  48. expect(aggs["1"].avg.field).to.be("@value");
  49. });
  50. it('with term agg and order by metric agg', function() {
  51. var query = builder.build({
  52. metrics: [
  53. {type: 'count', id: '1'},
  54. {type: 'avg', field: '@value', id: '5'}
  55. ],
  56. bucketAggs: [
  57. {type: 'terms', field: '@host', settings: {size: 5, order: 'asc', orderBy: '5'}, id: '2' },
  58. {type: 'date_histogram', field: '@timestamp', id: '3'}
  59. ],
  60. }, 100, 1000);
  61. var firstLevel = query.aggs["2"];
  62. var secondLevel = firstLevel.aggs["3"];
  63. expect(firstLevel.aggs["5"].avg.field).to.be("@value");
  64. expect(secondLevel.aggs["5"].avg.field).to.be("@value");
  65. });
  66. it('with metric percentiles', function() {
  67. var query = builder.build({
  68. metrics: [
  69. {
  70. id: '1',
  71. type: 'percentiles',
  72. field: '@load_time',
  73. settings: {
  74. percents: [1,2,3,4]
  75. }
  76. }
  77. ],
  78. bucketAggs: [
  79. {type: 'date_histogram', field: '@timestamp', id: '3'}
  80. ],
  81. }, 100, 1000);
  82. var firstLevel = query.aggs["3"];
  83. expect(firstLevel.aggs["1"].percentiles.field).to.be("@load_time");
  84. expect(firstLevel.aggs["1"].percentiles.percents).to.eql([1,2,3,4]);
  85. });
  86. it('with filters aggs', function() {
  87. var query = builder.build({
  88. metrics: [{type: 'count', id: '1'}],
  89. timeField: '@timestamp',
  90. bucketAggs: [
  91. {
  92. id: '2',
  93. type: 'filters',
  94. settings: {
  95. filters: [
  96. {query: '@metric:cpu' },
  97. {query: '@metric:logins.count' },
  98. ]
  99. }
  100. },
  101. {type: 'date_histogram', field: '@timestamp', id: '4'}
  102. ],
  103. });
  104. expect(query.aggs["2"].filters.filters["@metric:cpu"].query_string.query).to.be("@metric:cpu");
  105. expect(query.aggs["2"].filters.filters["@metric:logins.count"].query_string.query).to.be("@metric:logins.count");
  106. expect(query.aggs["2"].aggs["4"].date_histogram.field).to.be("@timestamp");
  107. });
  108. it('with filters aggs on es5.x', function() {
  109. var builder_5x = new ElasticQueryBuilder({
  110. timeField: '@timestamp',
  111. esVersion: 5
  112. });
  113. var query = builder_5x.build({
  114. metrics: [{type: 'count', id: '1'}],
  115. timeField: '@timestamp',
  116. bucketAggs: [
  117. {
  118. id: '2',
  119. type: 'filters',
  120. settings: {
  121. filters: [
  122. {query: '@metric:cpu' },
  123. {query: '@metric:logins.count' },
  124. ]
  125. }
  126. },
  127. {type: 'date_histogram', field: '@timestamp', id: '4'}
  128. ],
  129. });
  130. expect(query.aggs["2"].filters.filters["@metric:cpu"].query_string.query).to.be("@metric:cpu");
  131. expect(query.aggs["2"].filters.filters["@metric:logins.count"].query_string.query).to.be("@metric:logins.count");
  132. expect(query.aggs["2"].aggs["4"].date_histogram.field).to.be("@timestamp");
  133. });
  134. it('with raw_document metric', function() {
  135. var query = builder.build({
  136. metrics: [{type: 'raw_document', id: '1'}],
  137. timeField: '@timestamp',
  138. bucketAggs: [],
  139. });
  140. expect(query.size).to.be(500);
  141. });
  142. it('with moving average', function() {
  143. var query = builder.build({
  144. metrics: [
  145. {
  146. id: '3',
  147. type: 'sum',
  148. field: '@value'
  149. },
  150. {
  151. id: '2',
  152. type: 'moving_avg',
  153. field: '3',
  154. pipelineAgg: '3'
  155. }
  156. ],
  157. bucketAggs: [
  158. {type: 'date_histogram', field: '@timestamp', id: '3'}
  159. ],
  160. });
  161. var firstLevel = query.aggs["3"];
  162. expect(firstLevel.aggs["2"]).not.to.be(undefined);
  163. expect(firstLevel.aggs["2"].moving_avg).not.to.be(undefined);
  164. expect(firstLevel.aggs["2"].moving_avg.buckets_path).to.be("3");
  165. });
  166. it('with broken moving average', function() {
  167. var query = builder.build({
  168. metrics: [
  169. {
  170. id: '3',
  171. type: 'sum',
  172. field: '@value'
  173. },
  174. {
  175. id: '2',
  176. type: 'moving_avg',
  177. pipelineAgg: '3'
  178. },
  179. {
  180. id: '4',
  181. type: 'moving_avg',
  182. pipelineAgg: 'Metric to apply moving average'
  183. }
  184. ],
  185. bucketAggs: [
  186. { type: 'date_histogram', field: '@timestamp', id: '3' }
  187. ],
  188. });
  189. var firstLevel = query.aggs["3"];
  190. expect(firstLevel.aggs["2"]).not.to.be(undefined);
  191. expect(firstLevel.aggs["2"].moving_avg).not.to.be(undefined);
  192. expect(firstLevel.aggs["2"].moving_avg.buckets_path).to.be("3");
  193. expect(firstLevel.aggs["4"]).to.be(undefined);
  194. });
  195. it('with derivative', function() {
  196. var query = builder.build({
  197. metrics: [
  198. {
  199. id: '3',
  200. type: 'sum',
  201. field: '@value'
  202. },
  203. {
  204. id: '2',
  205. type: 'derivative',
  206. pipelineAgg: '3'
  207. }
  208. ],
  209. bucketAggs: [
  210. {type: 'date_histogram', field: '@timestamp', id: '3'}
  211. ],
  212. });
  213. var firstLevel = query.aggs["3"];
  214. expect(firstLevel.aggs["2"]).not.to.be(undefined);
  215. expect(firstLevel.aggs["2"].derivative).not.to.be(undefined);
  216. expect(firstLevel.aggs["2"].derivative.buckets_path).to.be("3");
  217. });
  218. it('with adhoc filters', function() {
  219. var query = builder.build({
  220. metrics: [{type: 'Count', id: '0'}],
  221. timeField: '@timestamp',
  222. bucketAggs: [{type: 'date_histogram', field: '@timestamp', id: '3'}],
  223. }, [
  224. {key: 'key1', operator: '=', value: 'value1'}
  225. ]);
  226. expect(query.query.bool.filter[2].term["key1"]).to.be("value1");
  227. });
  228. });