doc/rrdgraph_rpn.pod

   1 =head1 NAME
   2
   3 rrdgraph_rpn - About RPN Math in rrdtool graph
   4
   5 =head1 SYNOPSIS
   6
   7 I<RPN expression>:=I<vname>|I<operator>|I<value>[,I<RPN expression>]
   8
   9 =head1 DESCRIPTION
  10
  11 If you have ever used a traditional HP calculator you already know
  12 B<RPN> (Reverse Polish Notation).
  13 The idea behind B<RPN> is that you have a stack and push
  14 your data onto this stack. Whenever you execute an operation, it
  15 takes as many elements from the stack as needed. Pushing is done
  16 implicitly, so whenever you specify a number or a variable, it gets
  17 pushed onto the stack automatically.
  18
  19 At the end of the calculation there should be one and only one value left on
  20 the stack.  This is the outcome of the function and this is what is put into
  21 the I<vname>.  For B<CDEF> instructions, the stack is processed for each
  22 data point on the graph. B<VDEF> instructions work on an entire data set in
  23 one run. Note, that currently B<VDEF> instructions only support a limited
  24 list of functions.
  25
  26 Example: C<VDEF:maximum=mydata,MAXIMUM>
  27
  28 This will set variable "maximum" which you now can use in the rest
  29 of your RRD script.
  30
  31 Example: C<CDEF:mydatabits=mydata,8,*>
  32
  33 This means:  push variable I<mydata>, push the number 8, execute
  34 the operator I<*>. The operator needs two elements and uses those
  35 to return one value.  This value is then stored in I<mydatabits>.
  36 As you may have guessed, this instruction means nothing more than
  37 I<mydatabits = mydata * 8>.  The real power of B<RPN> lies in the
  38 fact that it is always clear in which order to process the input.
  39 For expressions like C<a = b + 3 * 5> you need to multiply 3 with
  40 5 first before you add I<b> to get I<a>. However, with parentheses
  41 you could change this order: C<a = (b + 3) * 5>. In B<RPN>, you
  42 would do C<a = b, 3, +, 5, *> without the need for parentheses.
  43
  44 =head1 OPERATORS
  45
  46 =over 4
  47
  48 =item Boolean operators
  49
  50 B<LT, LE, GT, GE, EQ, NE>
  51
  52 Pop two elements from the stack, compare them for the selected condition
  53 and return 1 for true or 0 for false. Comparing an I<unknown> or an
  54 I<infinite> value will always result in 0 (false).
  55
  56 B<UN, ISINF>
  57
  58 Pop one element from the stack, compare this to I<unknown> respectively
  59 to I<positive or negative infinity>. Returns 1 for true or 0 for false.
  60
  61 B<IF>
  62
  63 Pops three elements from the stack.  If the element popped last is 0
  64 (false), the value popped first is pushed back onto the stack,
  65 otherwise the value popped second is pushed back. This does, indeed,
  66 mean that any value other than 0 is considered to be true.
  67
  68 Example: C<A,B,C,IF> should be read as C<if (A) then (B) else (C)>
  69
  70 Z<>
  71
  72 =item Comparing values
  73
  74 B<MIN, MAX>
  75
  76 Pops two elements from the stack and returns the smaller or larger,
  77 respectively.  Note that I<infinite> is larger than anything else.
  78 If one of the input numbers is I<unknown> then the result of the operation will be
  79 I<unknown> too.
  80
  81 B<LIMIT>
  82
  83 Pops two elements from the stack and uses them to define a range.
  84 Then it pops another element and if it falls inside the range, it
  85 is pushed back. If not, an I<unknown> is pushed.
  86
  87 The range defined includes the two boundaries (so: a number equal
  88 to one of the boundaries will be pushed back). If any of the three
  89 numbers involved is either I<unknown> or I<infinite> this function
  90 will always return an I<unknown>
  91
  92 Example: C<CDEF:a=alpha,0,100,LIMIT> will return I<unknown> if
  93 alpha is lower than 0 or if it is higher than 100.
  94
  95 Z<>
  96
  97 =item Arithmetics
  98
  99 B<+, -, *, /, %>
 100
 101 Add, subtract, multiply, divide, modulo
 102
 103 B<ADDNAN>
 104
 105 NAN-safe addition. If one parameter is NAN/UNKNOWN it'll be treated as
 106 zero. If both parameters are NAN/UNKNOWN, NAN/UNKNOWN will be returned.
 107
 108 B<SIN, COS, LOG, EXP, SQRT>
 109
 110 Sine and cosine (input in radians), log and exp (natural logarithm),
 111 square root.
 112
 113 B<ATAN>
 114
 115 Arctangent (output in radians).
 116
 117 B<ATAN2>
 118
 119 Arctangent of y,x components (output in radians).
 120 This pops one element from the stack, the x (cosine) component, and then
 121 a second, which is the y (sine) component.
 122 It then pushes the arctangent of their ratio, resolving the ambiguity between
 123 quadrants.
 124
 125 Example: C<CDEF:angle=Y,X,ATAN2,RAD2DEG> will convert C<X,Y>
 126 components into an angle in degrees.
 127
 128 B<FLOOR, CEIL>
 129
 130 Round down or up to the nearest integer.
 131
 132 B<DEG2RAD, RAD2DEG>
 133
 134 Convert angle in degrees to radians, or radians to degrees.
 135
 136 B<ABS>
 137
 138 Take the absolute value.
 139
 140 =item Set Operations
 141
 142 B<SORT, REV>
 143
 144 Pop one element from the stack.  This is the I<count> of items to be sorted
 145 (or reversed).  The top I<count> of the remaining elements are then sorted
 146 (or reversed) in place on the stack.
 147
 148 Example: C<CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/> will
 149 compute the average of the values v1 to v6 after removing the smallest and
 150 largest.
 151
 152 B<AVG>
 153
 154 Pop one element (I<count>) from the stack. Now pop I<count> elements and build the
 155 average, ignoring all UNKNOWN values in the process.
 156
 157 Example: C<CDEF:x=a,b,c,d,4,AVG>
 158
 159 B<TREND, TRENDNAN>
 160
 161 Create a "sliding window" average of another data series.
 162
 163 Usage:
 164 CDEF:smoothed=x,1800,TREND
 165
 166 This will create a half-hour (1800 second) sliding window average of x.  The
 167 average is essentially computed as shown here:
 168
 169                  +---!---!---!---!---!---!---!---!--->
 170                                                      now
 171                        delay     t0
 172                  <--------------->
 173                          delay       t1
 174                      <--------------->
 175                               delay      t2
 176                          <--------------->
 177
 178
 179      Value at sample (t0) will be the average between (t0-delay) and (t0)
 180      Value at sample (t1) will be the average between (t1-delay) and (t1)
 181      Value at sample (t2) will be the average between (t2-delay) and (t2)
 182
 183 TRENDNAN is - in contrast to TREND - NAN-safe. If you use TREND and one
 184 source value is NAN the complete sliding window is affected. The TRENDNAN
 185 operation ignores all NAN-values in a sliding window and computes the
 186 average of the remaining values.
 187
 188
 189 =item Special values
 190
 191 B<UNKN>
 192
 193 Pushes an unknown value on the stack
 194
 195 B<INF, NEGINF>
 196
 197 Pushes a positive or negative infinite value on the stack. When
 198 such a value is graphed, it appears at the top or bottom of the
 199 graph, no matter what the actual value on the y-axis is.
 200
 201 B<PREV>
 202
 203 Pushes an I<unknown> value if this is the first value of a data
 204 set or otherwise the result of this B<CDEF> at the previous time
 205 step. This allows you to do calculations across the data.  This
 206 function cannot be used in B<VDEF> instructions.
 207
 208 B<PREV(vname)>
 209
 210 Pushes an I<unknown> value if this is the first value of a data
 211 set or otherwise the result of the vname variable at the previous time
 212 step. This allows you to do calculations across the data. This
 213 function cannot be used in B<VDEF> instructions.
 214
 215 B<COUNT>
 216
 217 Pushes the number 1 if this is the first value of the data set, the
 218 number 2 if it is the second, and so on. This special value allows
 219 you to make calculations based on the position of the value within
 220 the data set. This function cannot be used in B<VDEF> instructions.
 221
 222 =item Time
 223
 224 Time inside RRDtool is measured in seconds since the epoch. The
 225 epoch is defined to be S<C<Thu Jan  1 00:00:00 UTC 1970>>.
 226
 227 B<NOW>
 228
 229 Pushes the current time on the stack.
 230
 231 B<TIME>
 232
 233 Pushes the time the currently processed value was taken at onto the stack.
 234
 235 B<LTIME>
 236
 237 Takes the time as defined by B<TIME>, applies the time zone offset
 238 valid at that time including daylight saving time if your OS supports
 239 it, and pushes the result on the stack.  There is an elaborate example
 240 in the examples section below on how to use this.
 241
 242 =item Processing the stack directly
 243
 244 B<DUP, POP, EXC>
 245
 246 Duplicate the top element, remove the top element, exchange the two
 247 top elements.
 248
 249 Z<>
 250
 251 =back
 252
 253 =head1 VARIABLES
 254
 255 These operators work only on B<VDEF> statements. Note that currently ONLY these work for B<VDEF>.
 256
 257 =over 4
 258
 259 =item MAXIMUM, MINIMUM, AVERAGE
 260
 261 Return the corresponding value, MAXIMUM and MINIMUM also return
 262 the first occurrence of that value in the time component.
 263
 264 Example: C<VDEF:avg=mydata,AVERAGE>
 265
 266 =item STDEV
 267
 268 Returns the standard deviation of the values.
 269
 270 Example: C<VDEF:stdev=mydata,STDEV>
 271
 272 =item LAST, FIRST
 273
 274 Return the last/first value including its time.  The time for
 275 FIRST is actually the start of the corresponding interval, whereas
 276 LAST returns the end of the corresponding interval.
 277
 278 Example: C<VDEF:first=mydata,FIRST>
 279
 280 =item TOTAL
 281
 282 Returns the rate from each defined time slot multiplied with the
 283 step size.  This can, for instance, return total bytes transfered
 284 when you have logged bytes per second. The time component returns
 285 the number of seconds.
 286
 287 Example: C<VDEF:total=mydata,TOTAL>
 288
 289 =item PERCENT
 290
 291 This should follow a B<DEF> or B<CDEF> I<vname>. The I<vname> is popped,
 292 another number is popped which is a certain percentage (0..100). The
 293 data set is then sorted and the value returned is chosen such that
 294 I<percentage> percent of the values is lower or equal than the result.
 295 I<Unknown> values are considered lower than any finite number for this
 296 purpose so if this operator returns an I<unknown> you have quite a lot
 297 of them in your data.  B<Inf>inite numbers are lesser, or more, than the
 298 finite numbers and are always more than the I<Unknown> numbers.
 299 (NaN E<lt> -INF E<lt> finite values E<lt> INF)
 300
 301 Example: C<VDEF:perc95=mydata,95,PERCENT>
 302
 303 =item LSLSLOPE, LSLINT, LSLCORREL
 304
 305 Return the parameters for a B<L>east B<S>quares B<L>ine I<(y = mx +b)>
 306 which approximate the provided dataset.  LSLSLOPE is the slope I<(m)> of
 307 the line related to the COUNT position of the data.  LSLINT is the
 308 y-intercept I<(b)>, which happens also to be the first data point on the
 309 graph. LSLCORREL is the Correlation Coefficient (also know as Pearson's
 310 Product Moment Correlation Coefficient).  It will range from 0 to +/-1
 311 and represents the quality of fit for the approximation.
 312
 313 Example: C<VDEF:slope=mydata,LSLSLOPE>
 314
 315 =back
 316
 317 =head1 SEE ALSO
 318
 319 L<rrdgraph> gives an overview of how B<rrdtool graph> works.
 320 L<rrdgraph_data> describes B<DEF>,B<CDEF> and B<VDEF> in detail.
 321 L<rrdgraph_rpn> describes the B<RPN> language used in the B<?DEF> statements.
 322 L<rrdgraph_graph> page describes all of the graph and print functions.
 323
 324 Make sure to read L<rrdgraph_examples> for tipsE<amp>tricks.
 325
 326 =head1 AUTHOR
 327
 328 Program by Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 329
 330 This manual page by Alex van den Bogaerdt E<lt>alex@vandenbogaerdt.nlE<gt>
 331 with corrections and/or additions by several people