LT, LE, GT, GE, EQ, NE
Pop two elements from the stack, compare them for the selected condition and return 1 for true or 0 for false. Comparing an unknown or an infinite value will always result in 0 (false).
Pop one element from the stack, compare this to unknown respectively to positive or negative infinity. Returns 1 for true or 0 for false.
Pops three elements from the stack. If the element popped last is 0 (false), the value popped first is pushed back onto the stack, otherwise the value popped second is pushed back. This does, indeed, mean that any value other than 0 is considered to be true.
Example: A,B,C,IF should be read as if (A) then (B) else (C)
Pops two elements from the stack and returns the smaller or larger, respectively. Note that infinite is larger than anything else. If one of the input numbers is unknown then the result of the operation will be unknown too.
Pops two elements from the stack and uses them to define a range. Then it pops another element and if it falls inside the range, it is pushed back. If not, an unknown is pushed.
The range defined includes the two boundaries (so: a number equal to one of the boundaries will be pushed back). If any of the three numbers involved is either unknown or infinite this function will always return an unknown
Example: CDEF:a=alpha,0,100,LIMIT will return unknown if alpha is lower than 0 or if it is higher than 100.
+, -, *, /, %
Add, subtract, multiply, divide, modulo
SIN, COS, LOG, EXP, SQRT
Sine and cosine (input in radians), log and exp (natural logarithm), square root.
Arctangent (output in radians).
Arctangent of y,x components (output in radians). This pops one element from the stack, the x (cosine) component, and then a second, which is the y (sine) component. It then pushes the arctangent of their ratio, resolving the ambiguity between quadrants.
Example: CDEF:angle=Y,X,ATAN2,RAD2DEG will convert X,Y components into an angle in degrees.
Round down or up to the nearest integer.
Convert angle in degrees to radians, or radians to degrees.
Take the absolute value.
Pop one element from the stack. This is the count of items to be sorted (or reversed). The top count of the remaining elements are then sorted (or reversed) in place on the stack.
Example: CDEF:x=v1,v2,v3,v4,v5,v6,6,SORT,POP,5,REV,POP,+,+,+,4,/ will compute the average of the values v1 to v6 after removing the smallest and largest.
Pop one element (count) from the stack. Now pop count elements and build the average, ignoring all UNKNOWN values in the process.
Create a sliding window average of another data series.
This will create a half-hour (1800 second) sliding window average of x. The average is essentially computed as shown here:
Pushes an unknown value on the stack
Pushes a positive or negative infinite value on the stack. When such a value is graphed, it appears at the top or bottom of the graph, no matter what the actual value on the y-axis is.
Pushes an unknown value if this is the first value of a data set or otherwise the result of this CDEF at the previous time step. This allows you to do calculations across the data. This function cannot be used in VDEF instructions.
Pushes an unknown value if this is the first value of a data set or otherwise the result of the vname variable at the previous time step. This allows you to do calculations across the data. This function cannot be used in VDEF instructions.
Pushes the number 1 if this is the first value of the data set, the number 2 if it is the second, and so on. This special value allows you to make calculations based on the position of the value within the data set. This function cannot be used in VDEF instructions.
Time inside RRDtool is measured in seconds since the epoch. The
epoch is defined to be Thu Jan 1 00:00:00 UTC 1970.
Pushes the current time on the stack.
Pushes the time the currently processed value was taken at onto the stack.
Takes the time as defined by TIME, applies the time zone offset valid at that time including daylight saving time if your OS supports it, and pushes the result on the stack. There is an elaborate example in the examples section below on how to use this.
|Processing the stack directly||
DUP, POP, EXC
Duplicate the top element, remove the top element, exchange the two top elements.
These operators work only on VDEF statements. Note that currently ONLY these work for VDEF.
MAXIMUM, MINIMUM, AVERAGE Return the corresponding value, MAXIMUM and MINIMUM also return the first occurrence of that value in the time component.
LAST, FIRST Return the last/first value including its time. The time for FIRST is actually the start of the corresponding interval, whereas LAST returns the end of the corresponding interval.
TOTAL Returns the rate from each defined time slot multiplied with the step size. This can, for instance, return total bytes transfered when you have logged bytes per second. The time component returns the number of seconds.
PERCENT This should follow a DEF or CDEF vname. The vname is popped, another number is popped which is a certain percentage (0..100). The data set is then sorted and the value returned is chosen such that percentage percent of the values is lower or equal than the result. Unknown values are considered lower than any finite number for this purpose so if this operator returns an unknown you have quite a lot of them in your data. Infinite numbers are lesser, or more, than the finite numbers and are always more than the Unknown numbers. (NaN < -INF < finite values < INF)
LSLSLOPE, LSLINT, LSLCORREL Return the parameters for a Least Squares Line (y = mx +b) which approximate the provided dataset. LSLSLOPE is the slope (m) of the line related to the COUNT position of the data. LSLINT is the y-intercept (b), which happens also to be the first data point on the graph. LSLCORREL is the Correlation Coefficient (also know as Pearsons Product Moment Correlation Coefficient). It will range from 0 to +/-1 and represents the quality of fit for the approximation.
rrdgraph gives an overview of how rrdtool graph works. rrdgraph_data describes DEF,CDEF and VDEF in detail. rrdgraph_rpn describes the RPN language used in the ?DEF statements. rrdgraph_graph page describes all of the graph and print functions.
Make sure to read rrdgraph_examples for tips&tricks.
Program by Tobias Oetiker <email@example.com>
This manual page by Alex van den Bogaerdt <firstname.lastname@example.org>