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            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
  98
  99            Sine and cosine (input in radians), log and exp (natural loga-
 100            rithm), square root.
 101
 102            A\bAT\bTA\bAN\bN
 103
 104            Arctangent (output in radians).
 105
 106            A\bAT\bTA\bAN\bN2\b2
 107
 108            Arctangent of y,x components (output in radians).  This pops one
 109            element from the stack, the x (cosine) component, and then a sec-
 110            ond, which is the y (sine) component.  It then pushes the arctan-
 111            gent of their ratio, resolving the ambiguity between quadrants.
 112
 113            Example: "CDEF:angle=Y,X,ATAN2,RAD2DEG" will convert "X,Y" compo-
 114            nents into an angle in degrees.
 115
 116            F\bFL\bLO\bOO\bOR\bR,\b, C\bCE\bEI\bIL\bL
 117
 118            Round down or up to the nearest integer.
 119
 120            D\bDE\bEG\bG2\b2R\bRA\bAD\bD,\b, R\bRA\bAD\bD2\b2D\bDE\bEG\bG
 121
 122            Convert angle in degrees to radians, or radians to degrees.
 123
 124            A\bAB\bBS\bS
 125
 126            Take the absolute value.
 127
 128        Set Operations
 129            S\bSO\bOR\bRT\bT,\b, R\bRE\bEV\bV
 130
 131            Pop one element from the stack.  This is the _\bc_\bo_\bu_\bn_\bt of items to be
 132            sorted (or reversed).  The top _\bc_\bo_\bu_\bn_\bt of the remaining elements are
 133            then sorted (or reversed) in place on the stack.
 134
 135            Example: "CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/"
 136            will compute the average of the values v1 to v6 after removing the
 137            smallest and largest.
 138
 139            A\bAV\bVG\bG
 140
 141            Pop one element (_\bc_\bo_\bu_\bn_\bt) from the stack. Now pop _\bc_\bo_\bu_\bn_\bt elements and
 142            build the average, ignoring all UNKNOWN values in the process.
 143
 144            Example: "CDEF:x=a,b,c,d,4,AVG"
 145
 146            T\bTR\bRE\bEN\bND\bD
 147
 148            Create a "sliding window" average of another data series.
 149
 150            Usage: CDEF:smoothed=x,1800,TREND
 151
 152            This will create a half-hour (1800 second) sliding window average
 153            of x.  The average is essentially computed as shown here:
 154
 155                             +---!---!---!---!---!---!---!---!--->
 156                                                                 now
 157                                   delay     t0
 158                             <--------------->
 159                                     delay       t1
 160                                 <--------------->
 161                                          delay      t2
 162                                     <--------------->
 163
 164                 Value at sample (t0) will be the average between (t0-delay) and (t0)
 165                 Value at sample (t1) will be the average between (t1-delay) and (t1)
 166                 Value at sample (t2) will be the average between (t2-delay) and (t2)
 167
 168        Special values
 169            U\bUN\bNK\bKN\bN
 170
 171            Pushes an unknown value on the stack
 172
 173            I\bIN\bNF\bF,\b, N\bNE\bEG\bGI\bIN\bNF\bF
 174
 175            Pushes a positive or negative infinite value on the stack. When
 176            such a value is graphed, it appears at the top or bottom of the
 177            graph, no matter what the actual value on the y-axis is.
 178
 179            P\bPR\bRE\bEV\bV
 180
 181            Pushes an _\bu_\bn_\bk_\bn_\bo_\bw_\bn value if this is the first value of a data set or
 182            otherwise the result of this C\bCD\bDE\bEF\bF at the previous time step. This
 183            allows you to do calculations across the data.  This function can-
 184            not be used in V\bVD\bDE\bEF\bF instructions.
 185
 186            P\bPR\bRE\bEV\bV(\b(v\bvn\bna\bam\bme\be)\b)
 187
 188            Pushes an _\bu_\bn_\bk_\bn_\bo_\bw_\bn value if this is the first value of a data set or
 189            otherwise the result of the vname variable at the previous time
 190            step. This allows you to do calculations across the data. This
 191            function cannot be used in V\bVD\bDE\bEF\bF instructions.
 192
 193            C\bCO\bOU\bUN\bNT\bT
 194
 195            Pushes the number 1 if this is the first value of the data set, the
 196            number 2 if it is the second, and so on. This special value allows
 197            you to make calculations based on the position of the value within
 198            the data set. This function cannot be used in V\bVD\bDE\bEF\bF instructions.
 199
 200        Time
 201            Time inside RRDtool is measured in seconds since the epoch. The
 202            epoch is defined to be "Thu Jan 1 00:00:00 UTC 1970".
 203
 204            N\bNO\bOW\bW
 205
 206            Pushes the current time on the stack.
 207
 208            T\bTI\bIM\bME\bE
 209
 210            Pushes the time the currently processed value was taken at onto the
 211            stack.
 212
 213            L\bLT\bTI\bIM\bME\bE
 214
 215            Takes the time as defined by T\bTI\bIM\bME\bE, applies the time zone offset
 216            valid at that time including daylight saving time if your OS sup-
 217            ports it, and pushes the result on the stack.  There is an elabo-
 218            rate example in the examples section below on how to use this.
 219
 220        Processing the stack directly
 221            D\bDU\bUP\bP,\b, P\bPO\bOP\bP,\b, E\bEX\bXC\bC
 222
 223            Duplicate the top element, remove the top element, exchange the two
 224            top elements.
 225
 226
 227
 228 V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
 229        These operators work only on V\bVD\bDE\bEF\bF statements. Note that currently ONLY
 230        these work for V\bVD\bDE\bEF\bF.
 231
 232        MAXIMUM, MINIMUM, AVERAGE
 233            Return the corresponding value, MAXIMUM and MINIMUM also return the
 234            first occurrence of that value in the time component.
 235
 236            Example: "VDEF:avg=mydata,AVERAGE"
 237
 238        LAST, FIRST
 239            Return the last/first value including its time.  The time for FIRST
 240            is actually the start of the corresponding interval, whereas LAST
 241            returns the end of the corresponding interval.
 242
 243            Example: "VDEF:first=mydata,FIRST"
 244
 245        TOTAL
 246            Returns the rate from each defined time slot multiplied with the
 247            step size.  This can, for instance, return total bytes transfered
 248            when you have logged bytes per second. The time component returns
 249            the number of seconds.
 250
 251            Example: "VDEF:total=mydata,TOTAL"
 252
 253        PERCENT
 254            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,
 255            another number is popped which is a certain percentage (0..100).
 256            The data set is then sorted and the value returned is chosen such
 257            that _\bp_\be_\br_\bc_\be_\bn_\bt_\ba_\bg_\be percent of the values is lower or equal than the
 258            result.  _\bU_\bn_\bk_\bn_\bo_\bw_\bn values are considered lower than any finite number
 259            for this purpose so if this operator returns an _\bu_\bn_\bk_\bn_\bo_\bw_\bn you have
 260            quite a lot of them in your data.  I\bIn\bnf\bfinite numbers are lesser, or
 261            more, than the finite numbers and are always more than the _\bU_\bn_\bk_\bn_\bo_\bw_\bn
 262            numbers.  (NaN < -INF < finite values < INF)
 263
 264            Example: "VDEF:perc95=mydata,95,PERCENT"
 265
 266        LSLSLOPE, LSLINT, LSLCORREL
 267            Return the parameters for a L\bLeast S\bSquares L\bLine _\b(_\by _\b= _\bm_\bx _\b+_\bb_\b) which
 268            approximate the provided dataset.  LSLSLOPE is the slope _\b(_\bm_\b) of the
 269            line related to the COUNT position of the data.  LSLINT is the
 270            y-intercept _\b(_\bb_\b), which happens also to be the first data point on
 271            the graph. LSLCORREL is the Correlation Coefficient (also know as
 272            Pearson's Product Moment Correlation Coefficient).  It will range
 273            from 0 to +/-1 and represents the quality of fit for the approxima-
 274            tion.
 275
 276            Example: "VDEF:slope=mydata,LSLSLOPE"
 277
 278 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 279        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
 280        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
 281        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
 282        all of the graph and print functions.
 283
 284        Make sure to read rrdgraph_examples for tips&tricks.
 285
 286 A\bAU\bUT\bTH\bHO\bOR\bR
 287        Program by Tobias Oetiker <tobi@oetiker.ch>
 288
 289        This manual page by Alex van den Bogaerdt <alex@ergens.op.het.net>
 290
 291
 292
 293 1.2.26                            2007-11-20                   RRDGRAPH_RPN(1)