doc/rrdgraph_rpn.txt

   1 RRDGRAPH_RPN(1)                     rrdtool                    RRDGRAPH_RPN(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdgraph_rpn - About RPN Math in rrdtool graph
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        _\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn:=_\bv_\bn_\ba_\bm_\be|_\bo_\bp_\be_\br_\ba_\bt_\bo_\br|_\bv_\ba_\bl_\bu_\be[,_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn]
  10
  11 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  12        If you have ever used a traditional HP calculator you already know R\bRP\bPN\bN.
  13        The idea behind R\bRP\bPN\bN is that you have a stack and push your data onto
  14        this stack. Whenever you execute an operation, it takes as many ele-
  15        ments from the stack as needed. Pushing is done implicitly, so whenever
  16        you specify a number or a variable, it gets pushed onto the stack auto-
  17        matically.
  18
  19        At the end of the calculation there should be one and only one value
  20        left on the stack.  This is the outcome of the function and this is
  21        what is put into the _\bv_\bn_\ba_\bm_\be.  For C\bCD\bDE\bEF\bF instructions, the stack is pro-
  22        cessed for each data point on the graph. V\bVD\bDE\bEF\bF instructions work on an
  23        entire data set in one run. Note, that currently V\bVD\bDE\bEF\bF instructions only
  24        support a limited list of functions.
  25
  26        Example: "VDEF:maximum=mydata,MAXIMUM"
  27
  28        This will set variable "maximum" which you now can use in the rest of
  29        your RRD script.
  30
  31        Example: "CDEF:mydatabits=mydata,8,*"
  32
  33        This means:  push variable _\bm_\by_\bd_\ba_\bt_\ba, push the number 8, execute the oper-
  34        ator _\b*. The operator needs two elements and uses those to return one
  35        value.  This value is then stored in _\bm_\by_\bd_\ba_\bt_\ba_\bb_\bi_\bt_\bs.  As you may have
  36        guessed, this instruction means nothing more than _\bm_\by_\bd_\ba_\bt_\ba_\bb_\bi_\bt_\bs _\b= _\bm_\by_\bd_\ba_\bt_\ba _\b*
  37        _\b8.  The real power of R\bRP\bPN\bN lies in the fact that it is always clear in
  38        which order to process the input.  For expressions like "a = b + 3 * 5"
  39        you need to multiply 3 with 5 first before you add _\bb to get _\ba. However,
  40        with parentheses you could change this order: "a = (b + 3) * 5". In
  41        R\bRP\bPN\bN, you would do "a = b, 3, +, 5, *" without the need for parentheses.
  42
  43 O\bOP\bPE\bER\bRA\bAT\bTO\bOR\bRS\bS
  44        Boolean operators
  45            L\bLT\bT,\b, L\bLE\bE,\b, G\bGT\bT,\b, G\bGE\bE,\b, E\bEQ\bQ,\b, N\bNE\bE
  46
  47            Pop two elements from the stack, compare them for the selected con-
  48            dition and return 1 for true or 0 for false. Comparing an _\bu_\bn_\bk_\bn_\bo_\bw_\bn
  49            or an _\bi_\bn_\bf_\bi_\bn_\bi_\bt_\be value will always result in 0 (false).
  50
  51            U\bUN\bN,\b, I\bIS\bSI\bIN\bNF\bF
  52
  53            Pop one element from the stack, compare this to _\bu_\bn_\bk_\bn_\bo_\bw_\bn respec-
  54            tively to _\bp_\bo_\bs_\bi_\bt_\bi_\bv_\be _\bo_\br _\bn_\be_\bg_\ba_\bt_\bi_\bv_\be _\bi_\bn_\bf_\bi_\bn_\bi_\bt_\by. Returns 1 for true or 0
  55            for false.
  56
  57            I\bIF\bF
  58
  59            Pops three elements from the stack.  If the element popped last is
  60            0 (false), the value popped first is pushed back onto the stack,
  61            otherwise the value popped second is pushed back. This does,
  62            indeed, mean that any value other than 0 is considered to be true.
  63
  64            Example: "A,B,C,IF" should be read as "if (A) then (B) else (C)"
  65
  66
  67
  68        Comparing values
  69            M\bMI\bIN\bN,\b, M\bMA\bAX\bX
  70
  71            Pops two elements from the stack and returns the smaller or larger,
  72            respectively.  Note that _\bi_\bn_\bf_\bi_\bn_\bi_\bt_\be is larger than anything else.  If
  73            one of the input numbers is _\bu_\bn_\bk_\bn_\bo_\bw_\bn then the result of the opera-
  74            tion will be _\bu_\bn_\bk_\bn_\bo_\bw_\bn too.
  75
  76            L\bLI\bIM\bMI\bIT\bT
  77
  78            Pops two elements from the stack and uses them to define a range.
  79            Then it pops another element and if it falls inside the range, it
  80            is pushed back. If not, an _\bu_\bn_\bk_\bn_\bo_\bw_\bn is pushed.
  81
  82            The range defined includes the two boundaries (so: a number equal
  83            to one of the boundaries will be pushed back). If any of the three
  84            numbers involved is either _\bu_\bn_\bk_\bn_\bo_\bw_\bn or _\bi_\bn_\bf_\bi_\bn_\bi_\bt_\be this function will
  85            always return an _\bu_\bn_\bk_\bn_\bo_\bw_\bn
  86
  87            Example: "CDEF:a=alpha,0,100,LIMIT" will return _\bu_\bn_\bk_\bn_\bo_\bw_\bn if alpha is
  88            lower than 0 or if it is higher than 100.
  89
  90
  91
  92        Arithmetics
  93            +\b+,\b, -\b-,\b, *\b*,\b, /\b/,\b, %\b%
  94
  95            Add, subtract, multiply, divide, modulo
  96
  97            A\bAD\bDD\bDN\bNA\bAN\bN
  98
  99            NAN-safe addition. If one parameter is NAN/UNKNOWN it'll be treated
 100            as zero. If both parameters are NAN/UNKNOWN, NAN/UNKNOWN will be
 101            returned.
 102
 103            S\bSI\bIN\bN,\b, C\bCO\bOS\bS,\b, L\bLO\bOG\bG,\b, E\bEX\bXP\bP,\b, S\bSQ\bQR\bRT\bT
 104
 105            Sine and cosine (input in radians), log and exp (natural loga-
 106            rithm), square root.
 107
 108            A\bAT\bTA\bAN\bN
 109
 110            Arctangent (output in radians).
 111
 112            A\bAT\bTA\bAN\bN2\b2
 113
 114            Arctangent of y,x components (output in radians).  This pops one
 115            element from the stack, the x (cosine) component, and then a sec-
 116            ond, which is the y (sine) component.  It then pushes the arctan-
 117            gent of their ratio, resolving the ambiguity between quadrants.
 118
 119            Example: "CDEF:angle=Y,X,ATAN2,RAD2DEG" will convert "X,Y" compo-
 120            nents into an angle in degrees.
 121
 122            F\bFL\bLO\bOO\bOR\bR,\b, C\bCE\bEI\bIL\bL
 123
 124            Round down or up to the nearest integer.
 125
 126            D\bDE\bEG\bG2\b2R\bRA\bAD\bD,\b, R\bRA\bAD\bD2\b2D\bDE\bEG\bG
 127
 128            Convert angle in degrees to radians, or radians to degrees.
 129
 130            A\bAB\bBS\bS
 131
 132            Take the absolute value.
 133
 134        Set Operations
 135            S\bSO\bOR\bRT\bT,\b, R\bRE\bEV\bV
 136
 137            Pop one element from the stack.  This is the _\bc_\bo_\bu_\bn_\bt of items to be
 138            sorted (or reversed).  The top _\bc_\bo_\bu_\bn_\bt of the remaining elements are
 139            then sorted (or reversed) in place on the stack.
 140
 141            Example: "CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/"
 142            will compute the average of the values v1 to v6 after removing the
 143            smallest and largest.
 144
 145            A\bAV\bVG\bG
 146
 147            Pop one element (_\bc_\bo_\bu_\bn_\bt) from the stack. Now pop _\bc_\bo_\bu_\bn_\bt elements and
 148            build the average, ignoring all UNKNOWN values in the process.
 149
 150            Example: "CDEF:x=a,b,c,d,4,AVG"
 151
 152            T\bTR\bRE\bEN\bND\bD,\b, T\bTR\bRE\bEN\bND\bDN\bNA\bAN\bN
 153
 154            Create a "sliding window" average of another data series.
 155
 156            Usage: CDEF:smoothed=x,1800,TREND
 157
 158            This will create a half-hour (1800 second) sliding window average
 159            of x.  The average is essentially computed as shown here:
 160
 161                             +---!---!---!---!---!---!---!---!--->
 162                                                                 now
 163                                   delay     t0
 164                             <--------------->
 165                                     delay       t1
 166                                 <--------------->
 167                                          delay      t2
 168                                     <--------------->
 169
 170                 Value at sample (t0) will be the average between (t0-delay) and (t0)
 171                 Value at sample (t1) will be the average between (t1-delay) and (t1)
 172                 Value at sample (t2) will be the average between (t2-delay) and (t2)
 173
 174            TRENDNAN is - in contrast to TREND - NAN-safe. If you use TREND and
 175            one source value is NAN the complete sliding window is affected.
 176            The TRENDNAN operation ignores all NAN-values in a sliding window
 177            and computes the average of the remaining values.
 178
 179        Special values
 180            U\bUN\bNK\bKN\bN
 181
 182            Pushes an unknown value on the stack
 183
 184            I\bIN\bNF\bF,\b, N\bNE\bEG\bGI\bIN\bNF\bF
 185
 186            Pushes a positive or negative infinite value on the stack. When
 187            such a value is graphed, it appears at the top or bottom of the
 188            graph, no matter what the actual value on the y-axis is.
 189
 190            P\bPR\bRE\bEV\bV
 191
 192            Pushes an _\bu_\bn_\bk_\bn_\bo_\bw_\bn value if this is the first value of a data set or
 193            otherwise the result of this C\bCD\bDE\bEF\bF at the previous time step. This
 194            allows you to do calculations across the data.  This function can-
 195            not be used in V\bVD\bDE\bEF\bF instructions.
 196
 197            P\bPR\bRE\bEV\bV(\b(v\bvn\bna\bam\bme\be)\b)
 198
 199            Pushes an _\bu_\bn_\bk_\bn_\bo_\bw_\bn value if this is the first value of a data set or
 200            otherwise the result of the vname variable at the previous time
 201            step. This allows you to do calculations across the data. This
 202            function cannot be used in V\bVD\bDE\bEF\bF instructions.
 203
 204            C\bCO\bOU\bUN\bNT\bT
 205
 206            Pushes the number 1 if this is the first value of the data set, the
 207            number 2 if it is the second, and so on. This special value allows
 208            you to make calculations based on the position of the value within
 209            the data set. This function cannot be used in V\bVD\bDE\bEF\bF instructions.
 210
 211        Time
 212            Time inside RRDtool is measured in seconds since the epoch. The
 213            epoch is defined to be "Thu Jan 1 00:00:00 UTC 1970".
 214
 215            N\bNO\bOW\bW
 216
 217            Pushes the current time on the stack.
 218
 219            T\bTI\bIM\bME\bE
 220
 221            Pushes the time the currently processed value was taken at onto the
 222            stack.
 223
 224            L\bLT\bTI\bIM\bME\bE
 225
 226            Takes the time as defined by T\bTI\bIM\bME\bE, applies the time zone offset
 227            valid at that time including daylight saving time if your OS sup-
 228            ports it, and pushes the result on the stack.  There is an elabo-
 229            rate example in the examples section below on how to use this.
 230
 231        Processing the stack directly
 232            D\bDU\bUP\bP,\b, P\bPO\bOP\bP,\b, E\bEX\bXC\bC
 233
 234            Duplicate the top element, remove the top element, exchange the two
 235            top elements.
 236
 237
 238
 239 V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
 240        These operators work only on V\bVD\bDE\bEF\bF statements. Note that currently ONLY
 241        these work for V\bVD\bDE\bEF\bF.
 242
 243        MAXIMUM, MINIMUM, AVERAGE
 244            Return the corresponding value, MAXIMUM and MINIMUM also return the
 245            first occurrence of that value in the time component.
 246
 247            Example: "VDEF:avg=mydata,AVERAGE"
 248
 249        STDEV
 250            Returns the standard deviation of the values.
 251
 252            Example: "VDEF:stdev=mydata,STDEV"
 253
 254        LAST, FIRST
 255            Return the last/first value including its time.  The time for FIRST
 256            is actually the start of the corresponding interval, whereas LAST
 257            returns the end of the corresponding interval.
 258
 259            Example: "VDEF:first=mydata,FIRST"
 260
 261        TOTAL
 262            Returns the rate from each defined time slot multiplied with the
 263            step size.  This can, for instance, return total bytes transfered
 264            when you have logged bytes per second. The time component returns
 265            the number of seconds.
 266
 267            Example: "VDEF:total=mydata,TOTAL"
 268
 269        PERCENT
 270            This should follow a D\bDE\bEF\bF or C\bCD\bDE\bEF\bF _\bv_\bn_\ba_\bm_\be. The _\bv_\bn_\ba_\bm_\be is popped,
 271            another number is popped which is a certain percentage (0..100).
 272            The data set is then sorted and the value returned is chosen such
 273            that _\bp_\be_\br_\bc_\be_\bn_\bt_\ba_\bg_\be percent of the values is lower or equal than the
 274            result.  _\bU_\bn_\bk_\bn_\bo_\bw_\bn values are considered lower than any finite number
 275            for this purpose so if this operator returns an _\bu_\bn_\bk_\bn_\bo_\bw_\bn you have
 276            quite a lot of them in your data.  I\bIn\bnf\bfinite numbers are lesser, or
 277            more, than the finite numbers and are always more than the _\bU_\bn_\bk_\bn_\bo_\bw_\bn
 278            numbers.  (NaN < -INF < finite values < INF)
 279
 280            Example: "VDEF:perc95=mydata,95,PERCENT"
 281
 282        LSLSLOPE, LSLINT, LSLCORREL
 283            Return the parameters for a L\bLeast S\bSquares L\bLine _\b(_\by _\b= _\bm_\bx _\b+_\bb_\b) which
 284            approximate the provided dataset.  LSLSLOPE is the slope _\b(_\bm_\b) of the
 285            line related to the COUNT position of the data.  LSLINT is the
 286            y-intercept _\b(_\bb_\b), which happens also to be the first data point on
 287            the graph. LSLCORREL is the Correlation Coefficient (also know as
 288            Pearson's Product Moment Correlation Coefficient).  It will range
 289            from 0 to +/-1 and represents the quality of fit for the approxima-
 290            tion.
 291
 292            Example: "VDEF:slope=mydata,LSLSLOPE"
 293
 294 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 295        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
 296        describes D\bDE\bEF\bF,C\bCD\bDE\bEF\bF and V\bVD\bDE\bEF\bF in detail.  rrdgraph_rpn describes the R\bRP\bPN\bN
 297        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
 298        all of the graph and print functions.
 299
 300        Make sure to read rrdgraph_examples for tips&tricks.
 301
 302 A\bAU\bUT\bTH\bHO\bOR\bR
 303        Program by Tobias Oetiker <tobi@oetiker.ch>
 304
 305        This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
 306
 307
 308
 309 1.3rc6                            2008-03-15                   RRDGRAPH_RPN(1)