gfunc.ts 23 KB

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