gfunc.ts 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008
  1. import _ from 'lodash';
  2. var index = [];
  3. var categories = {
  4. Combine: [],
  5. Transform: [],
  6. Calculate: [],
  7. Filter: [],
  8. Special: [],
  9. };
  10. function addFuncDef(funcDef) {
  11. funcDef.params = funcDef.params || [];
  12. funcDef.defaultParams = funcDef.defaultParams || [];
  13. if (funcDef.category) {
  14. funcDef.category.push(funcDef);
  15. }
  16. index[funcDef.name] = funcDef;
  17. index[funcDef.shortName || funcDef.name] = funcDef;
  18. }
  19. var optionalSeriesRefArgs = [
  20. { name: 'other', type: 'value_or_series', optional: true },
  21. { name: 'other', type: 'value_or_series', optional: true },
  22. { name: 'other', type: 'value_or_series', optional: true },
  23. { name: 'other', type: 'value_or_series', optional: true },
  24. { name: 'other', type: 'value_or_series', optional: true },
  25. ];
  26. addFuncDef({
  27. name: 'scaleToSeconds',
  28. category: categories.Transform,
  29. params: [{ name: 'seconds', type: 'int' }],
  30. defaultParams: [1],
  31. });
  32. addFuncDef({
  33. name: 'perSecond',
  34. category: categories.Transform,
  35. params: [{ name: 'max value', type: 'int', optional: true }],
  36. defaultParams: [],
  37. });
  38. addFuncDef({
  39. name: 'holtWintersForecast',
  40. category: categories.Calculate,
  41. });
  42. addFuncDef({
  43. name: 'holtWintersConfidenceBands',
  44. category: categories.Calculate,
  45. params: [{ name: 'delta', type: 'int' }],
  46. defaultParams: [3],
  47. });
  48. addFuncDef({
  49. name: 'holtWintersAberration',
  50. category: categories.Calculate,
  51. params: [{ name: 'delta', type: 'int' }],
  52. defaultParams: [3],
  53. });
  54. addFuncDef({
  55. name: 'nPercentile',
  56. category: categories.Calculate,
  57. params: [{ name: 'Nth percentile', type: 'int' }],
  58. defaultParams: [95],
  59. });
  60. addFuncDef({
  61. name: 'diffSeries',
  62. params: optionalSeriesRefArgs,
  63. defaultParams: ['#A'],
  64. category: categories.Calculate,
  65. });
  66. addFuncDef({
  67. name: 'stddevSeries',
  68. params: optionalSeriesRefArgs,
  69. defaultParams: [''],
  70. category: categories.Calculate,
  71. });
  72. addFuncDef({
  73. name: 'divideSeries',
  74. params: optionalSeriesRefArgs,
  75. defaultParams: ['#A'],
  76. category: categories.Calculate,
  77. });
  78. addFuncDef({
  79. name: 'multiplySeries',
  80. params: optionalSeriesRefArgs,
  81. defaultParams: ['#A'],
  82. category: categories.Calculate,
  83. });
  84. addFuncDef({
  85. name: 'asPercent',
  86. params: optionalSeriesRefArgs,
  87. defaultParams: ['#A'],
  88. category: categories.Calculate,
  89. });
  90. addFuncDef({
  91. name: 'group',
  92. params: optionalSeriesRefArgs,
  93. defaultParams: ['#A', '#B'],
  94. category: categories.Combine,
  95. });
  96. addFuncDef({
  97. name: 'sumSeries',
  98. shortName: 'sum',
  99. category: categories.Combine,
  100. params: optionalSeriesRefArgs,
  101. defaultParams: [''],
  102. });
  103. addFuncDef({
  104. name: 'averageSeries',
  105. shortName: 'avg',
  106. category: categories.Combine,
  107. params: optionalSeriesRefArgs,
  108. defaultParams: [''],
  109. });
  110. addFuncDef({
  111. name: 'rangeOfSeries',
  112. category: categories.Combine,
  113. });
  114. addFuncDef({
  115. name: 'percentileOfSeries',
  116. category: categories.Combine,
  117. params: [{ name: 'n', type: 'int' }, { name: 'interpolate', type: 'boolean', options: ['true', 'false'] }],
  118. defaultParams: [95, 'false'],
  119. });
  120. addFuncDef({
  121. name: 'sumSeriesWithWildcards',
  122. category: categories.Combine,
  123. params: [
  124. { name: 'node', type: 'int' },
  125. { name: 'node', type: 'int', optional: true },
  126. { name: 'node', type: 'int', optional: true },
  127. { name: 'node', type: 'int', optional: true },
  128. ],
  129. defaultParams: [3],
  130. });
  131. addFuncDef({
  132. name: 'maxSeries',
  133. shortName: 'max',
  134. category: categories.Combine,
  135. });
  136. addFuncDef({
  137. name: 'minSeries',
  138. shortName: 'min',
  139. category: categories.Combine,
  140. });
  141. addFuncDef({
  142. name: 'averageSeriesWithWildcards',
  143. category: categories.Combine,
  144. params: [{ name: 'node', type: 'int' }, { name: 'node', type: 'int', optional: true }],
  145. defaultParams: [3],
  146. });
  147. addFuncDef({
  148. name: 'alias',
  149. category: categories.Special,
  150. params: [{ name: 'alias', type: 'string' }],
  151. defaultParams: ['alias'],
  152. });
  153. addFuncDef({
  154. name: 'aliasSub',
  155. category: categories.Special,
  156. params: [{ name: 'search', type: 'string' }, { name: 'replace', type: 'string' }],
  157. defaultParams: ['', '\\1'],
  158. });
  159. addFuncDef({
  160. name: 'stacked',
  161. category: categories.Special,
  162. params: [{ name: 'stack', type: 'string' }],
  163. defaultParams: ['stacked'],
  164. });
  165. addFuncDef({
  166. name: 'consolidateBy',
  167. category: categories.Special,
  168. params: [
  169. {
  170. name: 'function',
  171. type: 'string',
  172. options: ['sum', 'average', 'min', 'max'],
  173. },
  174. ],
  175. defaultParams: ['max'],
  176. });
  177. addFuncDef({
  178. name: 'cumulative',
  179. category: categories.Special,
  180. params: [],
  181. defaultParams: [],
  182. });
  183. addFuncDef({
  184. name: 'groupByNode',
  185. category: categories.Special,
  186. params: [
  187. {
  188. name: 'node',
  189. type: 'int',
  190. options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12],
  191. },
  192. {
  193. name: 'function',
  194. type: 'string',
  195. options: ['sum', 'avg', 'maxSeries'],
  196. },
  197. ],
  198. defaultParams: [3, 'sum'],
  199. });
  200. addFuncDef({
  201. name: 'aliasByNode',
  202. category: categories.Special,
  203. params: [
  204. { name: 'node', type: 'int', options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  205. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  206. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  207. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  208. ],
  209. defaultParams: [3],
  210. });
  211. addFuncDef({
  212. name: 'substr',
  213. category: categories.Special,
  214. params: [
  215. { name: 'start', type: 'int', options: [-6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  216. { name: 'stop', type: 'int', options: [-6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  217. ],
  218. defaultParams: [0, 0],
  219. });
  220. addFuncDef({
  221. name: 'sortByName',
  222. category: categories.Special,
  223. params: [{ name: 'natural', type: 'boolean', options: ['true', 'false'], optional: true }],
  224. defaultParams: ['false'],
  225. });
  226. addFuncDef({
  227. name: 'sortByMaxima',
  228. category: categories.Special,
  229. });
  230. addFuncDef({
  231. name: 'sortByMinima',
  232. category: categories.Special,
  233. });
  234. addFuncDef({
  235. name: 'sortByTotal',
  236. category: categories.Special,
  237. });
  238. addFuncDef({
  239. name: 'aliasByMetric',
  240. category: categories.Special,
  241. });
  242. addFuncDef({
  243. name: 'randomWalk',
  244. fake: true,
  245. category: categories.Special,
  246. params: [{ name: 'name', type: 'string' }],
  247. defaultParams: ['randomWalk'],
  248. });
  249. addFuncDef({
  250. name: 'countSeries',
  251. category: categories.Special,
  252. });
  253. addFuncDef({
  254. name: 'constantLine',
  255. category: categories.Special,
  256. params: [{ name: 'value', type: 'int' }],
  257. defaultParams: [10],
  258. });
  259. addFuncDef({
  260. name: 'cactiStyle',
  261. category: categories.Special,
  262. });
  263. addFuncDef({
  264. name: 'keepLastValue',
  265. category: categories.Special,
  266. params: [{ name: 'n', type: 'int' }],
  267. defaultParams: [100],
  268. });
  269. addFuncDef({
  270. name: 'changed',
  271. category: categories.Special,
  272. params: [],
  273. defaultParams: [],
  274. });
  275. addFuncDef({
  276. name: 'scale',
  277. category: categories.Transform,
  278. params: [{ name: 'factor', type: 'int' }],
  279. defaultParams: [1],
  280. });
  281. addFuncDef({
  282. name: 'offset',
  283. category: categories.Transform,
  284. params: [{ name: 'amount', type: 'int' }],
  285. defaultParams: [10],
  286. });
  287. addFuncDef({
  288. name: 'transformNull',
  289. category: categories.Transform,
  290. params: [{ name: 'amount', type: 'int' }],
  291. defaultParams: [0],
  292. });
  293. addFuncDef({
  294. name: 'integral',
  295. category: categories.Transform,
  296. });
  297. addFuncDef({
  298. name: 'derivative',
  299. category: categories.Transform,
  300. });
  301. addFuncDef({
  302. name: 'nonNegativeDerivative',
  303. category: categories.Transform,
  304. params: [{ name: 'max value or 0', type: 'int', optional: true }],
  305. defaultParams: [''],
  306. });
  307. addFuncDef({
  308. name: 'timeShift',
  309. category: categories.Transform,
  310. params: [{ name: 'amount', type: 'select', options: ['1h', '6h', '12h', '1d', '2d', '7d', '14d', '30d'] }],
  311. defaultParams: ['1d'],
  312. });
  313. addFuncDef({
  314. name: 'timeStack',
  315. category: categories.Transform,
  316. params: [
  317. { name: 'timeShiftUnit', type: 'select', options: ['1h', '6h', '12h', '1d', '2d', '7d', '14d', '30d'] },
  318. { name: 'timeShiftStart', type: 'int' },
  319. { name: 'timeShiftEnd', type: 'int' },
  320. ],
  321. defaultParams: ['1d', 0, 7],
  322. });
  323. addFuncDef({
  324. name: 'summarize',
  325. category: categories.Transform,
  326. params: [
  327. { name: 'interval', type: 'string' },
  328. { name: 'func', type: 'select', options: ['sum', 'avg', 'min', 'max', 'last'] },
  329. { name: 'alignToFrom', type: 'boolean', optional: true, options: ['false', 'true'] },
  330. ],
  331. defaultParams: ['1h', 'sum', 'false'],
  332. });
  333. addFuncDef({
  334. name: 'smartSummarize',
  335. category: categories.Transform,
  336. params: [
  337. { name: 'interval', type: 'string' },
  338. { name: 'func', type: 'select', options: ['sum', 'avg', 'min', 'max', 'last'] },
  339. ],
  340. defaultParams: ['1h', 'sum'],
  341. });
  342. addFuncDef({
  343. name: 'absolute',
  344. category: categories.Transform,
  345. });
  346. addFuncDef({
  347. name: 'hitcount',
  348. category: categories.Transform,
  349. params: [{ name: 'interval', type: 'string' }],
  350. defaultParams: ['10s'],
  351. });
  352. addFuncDef({
  353. name: 'log',
  354. category: categories.Transform,
  355. params: [{ name: 'base', type: 'int' }],
  356. defaultParams: ['10'],
  357. });
  358. addFuncDef({
  359. name: 'averageAbove',
  360. category: categories.Filter,
  361. params: [{ name: 'n', type: 'int' }],
  362. defaultParams: [25],
  363. });
  364. addFuncDef({
  365. name: 'averageBelow',
  366. category: categories.Filter,
  367. params: [{ name: 'n', type: 'int' }],
  368. defaultParams: [25],
  369. });
  370. addFuncDef({
  371. name: 'currentAbove',
  372. category: categories.Filter,
  373. params: [{ name: 'n', type: 'int' }],
  374. defaultParams: [25],
  375. });
  376. addFuncDef({
  377. name: 'currentBelow',
  378. category: categories.Filter,
  379. params: [{ name: 'n', type: 'int' }],
  380. defaultParams: [25],
  381. });
  382. addFuncDef({
  383. name: 'maximumAbove',
  384. category: categories.Filter,
  385. params: [{ name: 'value', type: 'int' }],
  386. defaultParams: [0],
  387. });
  388. addFuncDef({
  389. name: 'maximumBelow',
  390. category: categories.Filter,
  391. params: [{ name: 'value', type: 'int' }],
  392. defaultParams: [0],
  393. });
  394. addFuncDef({
  395. name: 'minimumAbove',
  396. category: categories.Filter,
  397. params: [{ name: 'value', type: 'int' }],
  398. defaultParams: [0],
  399. });
  400. addFuncDef({
  401. name: 'minimumBelow',
  402. category: categories.Filter,
  403. params: [{ name: 'value', type: 'int' }],
  404. defaultParams: [0],
  405. });
  406. addFuncDef({
  407. name: 'limit',
  408. category: categories.Filter,
  409. params: [{ name: 'n', type: 'int' }],
  410. defaultParams: [5],
  411. });
  412. addFuncDef({
  413. name: 'mostDeviant',
  414. category: categories.Filter,
  415. params: [{ name: 'n', type: 'int' }],
  416. defaultParams: [10],
  417. });
  418. addFuncDef({
  419. name: 'exclude',
  420. category: categories.Filter,
  421. params: [{ name: 'exclude', type: 'string' }],
  422. defaultParams: ['exclude'],
  423. });
  424. addFuncDef({
  425. name: 'highestCurrent',
  426. category: categories.Filter,
  427. params: [{ name: 'count', type: 'int' }],
  428. defaultParams: [5],
  429. });
  430. addFuncDef({
  431. name: 'highestMax',
  432. category: categories.Filter,
  433. params: [{ name: 'count', type: 'int' }],
  434. defaultParams: [5],
  435. });
  436. addFuncDef({
  437. name: 'lowestCurrent',
  438. category: categories.Filter,
  439. params: [{ name: 'count', type: 'int' }],
  440. defaultParams: [5],
  441. });
  442. addFuncDef({
  443. name: 'movingAverage',
  444. category: categories.Filter,
  445. params: [
  446. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  447. ],
  448. defaultParams: [10],
  449. });
  450. addFuncDef({
  451. name: 'movingMedian',
  452. category: categories.Filter,
  453. params: [
  454. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  455. ],
  456. defaultParams: ['5'],
  457. });
  458. addFuncDef({
  459. name: 'stdev',
  460. category: categories.Filter,
  461. params: [{ name: 'n', type: 'int' }, { name: 'tolerance', type: 'int' }],
  462. defaultParams: [5, 0.1],
  463. });
  464. addFuncDef({
  465. name: 'highestAverage',
  466. category: categories.Filter,
  467. params: [{ name: 'count', type: 'int' }],
  468. defaultParams: [5],
  469. });
  470. addFuncDef({
  471. name: 'lowestAverage',
  472. category: categories.Filter,
  473. params: [{ name: 'count', type: 'int' }],
  474. defaultParams: [5],
  475. });
  476. addFuncDef({
  477. name: 'removeAbovePercentile',
  478. category: categories.Filter,
  479. params: [{ name: 'n', type: 'int' }],
  480. defaultParams: [5],
  481. });
  482. addFuncDef({
  483. name: 'removeAboveValue',
  484. category: categories.Filter,
  485. params: [{ name: 'n', type: 'int' }],
  486. defaultParams: [5],
  487. });
  488. addFuncDef({
  489. name: 'removeBelowPercentile',
  490. category: categories.Filter,
  491. params: [{ name: 'n', type: 'int' }],
  492. defaultParams: [5],
  493. });
  494. addFuncDef({
  495. name: 'removeBelowValue',
  496. category: categories.Filter,
  497. params: [{ name: 'n', type: 'int' }],
  498. defaultParams: [5],
  499. });
  500. addFuncDef({
  501. name: 'useSeriesAbove',
  502. category: categories.Filter,
  503. params: [{ name: 'value', type: 'int' }, { name: 'search', type: 'string' }, { name: 'replace', type: 'string' }],
  504. defaultParams: [0, 'search', 'replace'],
  505. });
  506. ////////////////////
  507. // Graphite 1.0.x //
  508. ////////////////////
  509. addFuncDef({
  510. name: 'aggregateLine',
  511. category: categories.Combine,
  512. params: [{ name: 'func', type: 'select', options: ['sum', 'avg', 'min', 'max', 'last'] }],
  513. defaultParams: ['avg'],
  514. version: '1.0',
  515. });
  516. addFuncDef({
  517. name: 'averageOutsidePercentile',
  518. category: categories.Filter,
  519. params: [{ name: 'n', type: 'int' }],
  520. defaultParams: [95],
  521. version: '1.0',
  522. });
  523. addFuncDef({
  524. name: 'delay',
  525. category: categories.Transform,
  526. params: [{ name: 'steps', type: 'int' }],
  527. defaultParams: [1],
  528. version: '1.0',
  529. });
  530. addFuncDef({
  531. name: 'exponentialMovingAverage',
  532. category: categories.Calculate,
  533. params: [
  534. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  535. ],
  536. defaultParams: [10],
  537. version: '1.0',
  538. });
  539. addFuncDef({
  540. name: 'fallbackSeries',
  541. category: categories.Special,
  542. params: [{ name: 'fallback', type: 'string' }],
  543. defaultParams: ['constantLine(0)'],
  544. version: '1.0',
  545. });
  546. addFuncDef({
  547. name: 'grep',
  548. category: categories.Filter,
  549. params: [{ name: 'grep', type: 'string' }],
  550. defaultParams: ['grep'],
  551. version: '1.0',
  552. });
  553. addFuncDef({
  554. name: 'groupByNodes',
  555. category: categories.Special,
  556. params: [
  557. {
  558. name: 'function',
  559. type: 'string',
  560. options: ['sum', 'avg', 'maxSeries'],
  561. },
  562. { name: 'node', type: 'int', options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  563. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  564. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  565. { name: 'node', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  566. ],
  567. defaultParams: ['sum', 3],
  568. version: '1.0',
  569. });
  570. addFuncDef({
  571. name: 'integralByInterval',
  572. category: categories.Transform,
  573. params: [{ name: 'intervalUnit', type: 'select', options: ['1h', '6h', '12h', '1d', '2d', '7d', '14d', '30d'] }],
  574. defaultParams: ['1d'],
  575. version: '1.0',
  576. });
  577. addFuncDef({
  578. name: 'interpolate',
  579. category: categories.Transform,
  580. params: [{ name: 'limit', type: 'int', optional: true }],
  581. defaultParams: [],
  582. version: '1.0',
  583. });
  584. addFuncDef({
  585. name: 'invert',
  586. category: categories.Transform,
  587. version: '1.0',
  588. });
  589. addFuncDef({
  590. name: 'isNonNull',
  591. category: categories.Combine,
  592. version: '1.0',
  593. });
  594. addFuncDef({
  595. name: 'linearRegression',
  596. category: categories.Calculate,
  597. params: [
  598. {
  599. name: 'startSourceAt',
  600. type: 'select',
  601. options: ['-1h', '-6h', '-12h', '-1d', '-2d', '-7d', '-14d', '-30d'],
  602. optional: true,
  603. },
  604. {
  605. name: 'endSourceAt',
  606. type: 'select',
  607. options: ['-1h', '-6h', '-12h', '-1d', '-2d', '-7d', '-14d', '-30d'],
  608. optional: true,
  609. },
  610. ],
  611. defaultParams: [],
  612. version: '1.0',
  613. });
  614. addFuncDef({
  615. name: 'mapSeries',
  616. shortName: 'map',
  617. params: [{ name: 'node', type: 'int' }],
  618. defaultParams: [3],
  619. category: categories.Combine,
  620. version: '1.0',
  621. });
  622. addFuncDef({
  623. name: 'movingMin',
  624. category: categories.Calculate,
  625. params: [
  626. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  627. ],
  628. defaultParams: [10],
  629. version: '1.0',
  630. });
  631. addFuncDef({
  632. name: 'movingMax',
  633. category: categories.Calculate,
  634. params: [
  635. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  636. ],
  637. defaultParams: [10],
  638. version: '1.0',
  639. });
  640. addFuncDef({
  641. name: 'movingSum',
  642. category: categories.Calculate,
  643. params: [
  644. { name: 'windowSize', type: 'int_or_interval', options: ['5', '7', '10', '5min', '10min', '30min', '1hour'] },
  645. ],
  646. defaultParams: [10],
  647. version: '1.0',
  648. });
  649. addFuncDef({
  650. name: 'multiplySeriesWithWildcards',
  651. category: categories.Calculate,
  652. params: [
  653. { name: 'position', type: 'int', options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  654. { name: 'position', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  655. { name: 'position', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  656. { name: 'position', type: 'int', options: [0, -1, -2, -3, -4, -5, -6, -7], optional: true },
  657. ],
  658. defaultParams: [2],
  659. version: '1.0',
  660. });
  661. addFuncDef({
  662. name: 'offsetToZero',
  663. category: categories.Transform,
  664. version: '1.0',
  665. });
  666. addFuncDef({
  667. name: 'pow',
  668. category: categories.Transform,
  669. params: [{ name: 'factor', type: 'int' }],
  670. defaultParams: [10],
  671. version: '1.0',
  672. });
  673. addFuncDef({
  674. name: 'powSeries',
  675. category: categories.Transform,
  676. params: optionalSeriesRefArgs,
  677. defaultParams: [''],
  678. version: '1.0',
  679. });
  680. addFuncDef({
  681. name: 'reduceSeries',
  682. shortName: 'reduce',
  683. params: [
  684. { name: 'function', type: 'string', options: ['asPercent', 'diffSeries', 'divideSeries'] },
  685. { name: 'reduceNode', type: 'int', options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13] },
  686. { name: 'reduceMatchers', type: 'string' },
  687. { name: 'reduceMatchers', type: 'string' },
  688. ],
  689. defaultParams: ['asPercent', 2, 'used_bytes', 'total_bytes'],
  690. category: categories.Combine,
  691. version: '1.0',
  692. });
  693. addFuncDef({
  694. name: 'removeBetweenPercentile',
  695. category: categories.Filter,
  696. params: [{ name: 'n', type: 'int' }],
  697. defaultParams: [95],
  698. version: '1.0',
  699. });
  700. addFuncDef({
  701. name: 'removeEmptySeries',
  702. category: categories.Filter,
  703. version: '1.0',
  704. });
  705. addFuncDef({
  706. name: 'squareRoot',
  707. category: categories.Transform,
  708. version: '1.0',
  709. });
  710. addFuncDef({
  711. name: 'timeSlice',
  712. category: categories.Transform,
  713. params: [
  714. { name: 'startSliceAt', type: 'select', options: ['-1h', '-6h', '-12h', '-1d', '-2d', '-7d', '-14d', '-30d'] },
  715. {
  716. name: 'endSliceAt',
  717. type: 'select',
  718. options: ['-1h', '-6h', '-12h', '-1d', '-2d', '-7d', '-14d', '-30d'],
  719. optional: true,
  720. },
  721. ],
  722. defaultParams: ['-1h'],
  723. version: '1.0',
  724. });
  725. addFuncDef({
  726. name: 'weightedAverage',
  727. category: categories.Filter,
  728. params: [
  729. { name: 'other', type: 'value_or_series', optional: true },
  730. { name: 'node', type: 'int', options: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12] },
  731. ],
  732. defaultParams: ['#A', 4],
  733. version: '1.0',
  734. });
  735. addFuncDef({
  736. name: 'seriesByTag',
  737. category: categories.Special,
  738. params: [
  739. { name: 'tagExpression', type: 'string' },
  740. { name: 'tagExpression', type: 'string', optional: true },
  741. { name: 'tagExpression', type: 'string', optional: true },
  742. { name: 'tagExpression', type: 'string', optional: true },
  743. ],
  744. version: '1.1',
  745. });
  746. addFuncDef({
  747. name: 'groupByTags',
  748. category: categories.Special,
  749. params: [
  750. {
  751. name: 'function',
  752. type: 'string',
  753. options: ['sum', 'avg', 'maxSeries'],
  754. },
  755. { name: 'tag', type: 'string' },
  756. { name: 'tag', type: 'string', optional: true },
  757. { name: 'tag', type: 'string', optional: true },
  758. { name: 'tag', type: 'string', optional: true },
  759. ],
  760. defaultParams: ['sum', 'tag'],
  761. version: '1.1',
  762. });
  763. addFuncDef({
  764. name: 'aliasByTags',
  765. category: categories.Special,
  766. params: [
  767. { name: 'tag', type: 'string' },
  768. { name: 'tag', type: 'string', optional: true },
  769. { name: 'tag', type: 'string', optional: true },
  770. { name: 'tag', type: 'string', optional: true },
  771. ],
  772. defaultParams: ['tag'],
  773. version: '1.1',
  774. });
  775. _.each(categories, function(funcList, catName) {
  776. categories[catName] = _.sortBy(funcList, 'name');
  777. });
  778. function FuncInstance(funcDef, options?) {
  779. this.def = funcDef;
  780. this.params = [];
  781. if (options && options.withDefaultParams) {
  782. this.params = funcDef.defaultParams.slice(0);
  783. }
  784. this.updateText();
  785. }
  786. function isNumeric(obj) {
  787. return !isNaN(parseFloat(obj)) && isFinite(obj);
  788. }
  789. FuncInstance.prototype.render = function(metricExp) {
  790. var str = this.def.name + '(';
  791. var parameters = _.map(
  792. this.params,
  793. function(value, index) {
  794. var paramType = this.def.params[index].type;
  795. if (paramType === 'int' || paramType === 'value_or_series' || paramType === 'boolean') {
  796. return value;
  797. } else if (paramType === 'int_or_interval' && isNumeric(value)) {
  798. return value;
  799. }
  800. return "'" + value + "'";
  801. }.bind(this),
  802. );
  803. if (metricExp) {
  804. parameters.unshift(metricExp);
  805. }
  806. return str + parameters.join(', ') + ')';
  807. };
  808. FuncInstance.prototype._hasMultipleParamsInString = function(strValue, index) {
  809. if (strValue.indexOf(',') === -1) {
  810. return false;
  811. }
  812. return this.def.params[index + 1] && this.def.params[index + 1].optional;
  813. };
  814. FuncInstance.prototype.updateParam = function(strValue, index) {
  815. // handle optional parameters
  816. // if string contains ',' and next param is optional, split and update both
  817. if (this._hasMultipleParamsInString(strValue, index)) {
  818. _.each(
  819. strValue.split(','),
  820. function(partVal, idx) {
  821. this.updateParam(partVal.trim(), index + idx);
  822. }.bind(this),
  823. );
  824. return;
  825. }
  826. if (strValue === '' && this.def.params[index].optional) {
  827. this.params.splice(index, 1);
  828. } else {
  829. this.params[index] = strValue;
  830. }
  831. this.updateText();
  832. };
  833. FuncInstance.prototype.updateText = function() {
  834. if (this.params.length === 0) {
  835. this.text = this.def.name + '()';
  836. return;
  837. }
  838. var text = this.def.name + '(';
  839. text += this.params.join(', ');
  840. text += ')';
  841. this.text = text;
  842. };
  843. function isVersionRelatedFunction(func, graphiteVersion) {
  844. return isVersionGreaterOrEqual(graphiteVersion, func.version) || !func.version;
  845. }
  846. function isVersionGreaterOrEqual(a, b) {
  847. var a_num = Number(a);
  848. var b_num = Number(b);
  849. return a_num >= b_num;
  850. }
  851. export default {
  852. createFuncInstance: function(funcDef, options?) {
  853. if (_.isString(funcDef)) {
  854. if (!index[funcDef]) {
  855. throw { message: 'Method not found ' + name };
  856. }
  857. funcDef = index[funcDef];
  858. }
  859. return new FuncInstance(funcDef, options);
  860. },
  861. getFuncDef: function(name) {
  862. return index[name];
  863. },
  864. getCategories: function(graphiteVersion) {
  865. var filteredCategories: any = {};
  866. _.each(categories, function(functions, category) {
  867. var filteredFuncs = _.filter(functions, function(func) {
  868. return isVersionRelatedFunction(func, graphiteVersion);
  869. });
  870. if (filteredFuncs.length) {
  871. filteredCategories[category] = filteredFuncs;
  872. }
  873. });
  874. return filteredCategories;
  875. },
  876. };