Skip to content

Commit 0fb8ba1

Browse files
grzkvgrzkv
committed
Added funcs short docs in the compatibility document
1 parent a406c1d commit 0fb8ba1

1 file changed

Lines changed: 125 additions & 0 deletions

File tree

‎COMPATIBILITY.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Functions diff compared to `graphite-web` v1.1.5](#functions-diff-compared-to-graphite-web-v115)
1010
- [Functions *present in graphite-web but absent in carbonapi*](#functions-present-in-graphite-web-but-absent-in-carbonapi)
1111
- [Functions *present in carbonapi but absent in graphite-web*](#functions-present-in-carbonapi-but-absent-in-graphite-web)
12+
- [Function short docs](#function-short-docs)
1213

1314
## Default Settings
1415

@@ -168,3 +169,127 @@ _When `format=png`_ (default if not specified)
168169
- stdev
169170
- tukeyAbove
170171
- tukeyBelow
172+
173+
## Function short docs
174+
175+
| Graphite Function |
176+
| :------------------------------------------------------------------------ |
177+
| absolute(seriesList) |
178+
| alias(seriesList, newName) |
179+
| aliasByMetric(seriesList) |
180+
| aliasByNode(seriesList, *nodes) |
181+
| aliasSub(seriesList, search, replace) |
182+
| alpha(seriesList, alpha) |
183+
| applyByNode(seriesList, nodeNum, templateFunction, newName=None) |
184+
| areaBetween(seriesList) |
185+
| asPercent(seriesList, total=None, *nodes) |
186+
| averageAbove(seriesList, n) |
187+
| averageBelow(seriesList, n) |
188+
| averageSeries(*seriesLists), Short Alias: avg() |
189+
| averageSeriesWithWildcards(seriesList, *position) |
190+
| cactiStyle(seriesList, system=None) |
191+
| changed(seriesList) |
192+
| color(seriesList, theColor) |
193+
| consolidateBy(seriesList, consolidationFunc) |
194+
| constantLine(value) |
195+
| countSeries(*seriesLists) |
196+
| cumulative(seriesList) |
197+
| currentAbove(seriesList, n) |
198+
| currentBelow(seriesList, n) |
199+
| dashed(*seriesList) |
200+
| delay(seriesList, steps) |
201+
| derivative(seriesList) |
202+
| diffSeries(*seriesLists) |
203+
| divideSeries(dividendSeriesList, divisorSeries) |
204+
| divideSeriesLists(dividendSeriesList, divisorSeriesList) |
205+
| diffSeriesLists(leftSeriesList, rightSeriesList) |
206+
| multiplySeriesLists(leftSeriesList, rightSeriesList) |
207+
| drawAsInfinite(seriesList) |
208+
| exclude(seriesList, pattern) |
209+
| exponentialWeightedMovingAverage(seriesList, alpha) |
210+
| ewma(seriesList, alpha) |
211+
| fallbackSeries( seriesList, fallback ) |
212+
| [fft](https://en.wikipedia.org/wiki/Fast_Fourier_transform)(absSeriesList, phaseSeriesList) |
213+
| grep(seriesList, pattern) |
214+
| group(*seriesLists) |
215+
| groupByNode(seriesList, nodeNum, callback) |
216+
| groupByNodes(seriesList, callback, *nodes) |
217+
| highestAverage(seriesList, n) |
218+
| highestCurrent(seriesList, n) |
219+
| highestMax(seriesList, n) |
220+
| hitcount(seriesList, intervalString, alignToInterval=False) |
221+
| holtWintersAberration(seriesList, delta=3) |
222+
| holtWintersConfidenceArea(seriesList, delta=3) |
223+
| holtWintersConfidenceBands(seriesList, delta=3) |
224+
| holtWintersForecast(seriesList) |
225+
| [ifft](https://en.wikipedia.org/wiki/Fast_Fourier_transform)(absSeriesList, phaseSeriesList) |
226+
| integral(seriesList) |
227+
| invert(seriesList) |
228+
| isNonNull(seriesList) |
229+
| keepLastValue(seriesList, limit=inf) |
230+
| [kolmogorovSmirnovTest2](https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test)(series, series, windowSize) alias ksTest2() |
231+
| legendValue(seriesList, *valueTypes) |
232+
| limit(seriesList, n) |
233+
| lineWidth(seriesList, width) |
234+
| linearRegression(seriesList, startSourceAt=None, endSourceAt=None) |
235+
| logarithm(seriesList, base=10), alias log() |
236+
| lowestAverage(seriesList, n) |
237+
| lowestCurrent(seriesList, n) |
238+
| [lowPass](https://en.wikipedia.org/wiki/Low-pass_filter)(seriesList, cutPercent) |
239+
| mapSeries(seriesList, mapNode), Short form: map() |
240+
| maxSeries(*seriesLists) |
241+
| maximumAbove(seriesList, n) |
242+
| maximumBelow(seriesList, n) |
243+
| minSeries(*seriesLists) |
244+
| minimumAbove(seriesList, n) |
245+
| minimumBelow(seriesList, n) |
246+
| mostDeviant(seriesList, n) |
247+
| movingAverage(seriesList, windowSize) |
248+
| movingMax(seriesList, windowSize) |
249+
| movingMedian(seriesList, windowSize) |
250+
| movingMin(seriesList, windowSize) |
251+
| movingSum(seriesList, windowSize) |
252+
| multiplySeries(*seriesLists) |
253+
| multiplySeriesWithWildcards(seriesList, *position) |
254+
| nPercentile(seriesList, n) |
255+
| nonNegativeDerivative(seriesList, maxValue=None) |
256+
| offset(seriesList, factor) |
257+
| offsetToZero(seriesList) |
258+
| [pearson](https://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient)(series, series, n) |
259+
| pearsonClosest(series, seriesList, windowSize, direction="abs") |
260+
| perSecond(seriesList, maxValue=None) |
261+
| percentileOfSeries(seriesList, n, interpolate=False) |
262+
| [polyfit](https://en.wikipedia.org/wiki/Polynomial_regression)(seriesList, degree=1, offset='0d') |
263+
| pow(seriesList, factor) |
264+
| randomWalkFunction(name, step=60), Short Alias: randomWalk() |
265+
| rangeOfSeries(*seriesLists) |
266+
| reduceSeries(seriesLists, reduceFunction, reduceNode, *reduceMatchers) |
267+
| reduce() |
268+
| removeAbovePercentile(seriesList, n) |
269+
| removeAboveValue(seriesList, n) |
270+
| removeBelowPercentile(seriesList, n) |
271+
| removeBelowValue(seriesList, n) |
272+
| removeEmptySeries(seriesList) |
273+
| removeZeroSeries(seriesList) |
274+
| scale(seriesList, factor) |
275+
| scaleToSeconds(seriesList, seconds) |
276+
| secondYAxis(seriesList) |
277+
| sortByMaxima(seriesList) |
278+
| sortByMinima(seriesList) |
279+
| sortByName(seriesList) |
280+
| sortByTotal(seriesList) |
281+
| squareRoot(seriesList) |
282+
| stacked(seriesLists, stackName='__DEFAULT__') |
283+
| stddevSeries(*seriesLists) |
284+
| stdev(seriesList, points, windowTolerance=0.1) |
285+
| substr(seriesList, start=0, stop=0) |
286+
| SUMSERIES(*SERIESLISTS), SHORT FORM: SUM() |
287+
| SUMSERIESWITHWILDCARDS(SERIESLIST, *POSITION) |
288+
| SUMMARIZE(SERIESLIST, INTERVALSTRING, FUNC='SUM', ALIGNTOFROM=FALSE) |
289+
| THRESHOLD(VALUE, LABEL=NONE, COLOR=NONE) |
290+
| TIMEFUNCTION(NAME, STEP=60), SHORT ALIAS: TIME() |
291+
| TIMESHIFT(SERIESLIST, TIMESHIFT, RESETEND=TRUE) |
292+
| TIMESTACK(SERIESLIST, TIMESHIFTUNIT, TIMESHIFTSTART, TIMESHIFTEND) |
293+
| [TUKEYABOVE](HTTPS://EN.WIKIPEDIA.ORG/WIKI/TUKEY%27S_RANGE_TEST)(SERIESLIST, BASIS, N, INTERVAL=0) |
294+
| [TUKEYBELOW](HTTPS://EN.WIKIPEDIA.ORG/WIKI/TUKEY%27S_RANGE_TEST)(SERIESLIST, BASIS, N, INTERVAL=0) |
295+
| TRANSFORMNULL(SERIESLIST, DEFAULT=0) |

0 commit comments

Comments
 (0)