gfunc.js 24 KB

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