doc/rrdgraph_data.txt

   1 RRDGRAPH_DATA(1)                    rrdtool                   RRDGRAPH_DATA(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdgraph_data - preparing data for graphing in rrdtool graph
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        D\bDE\bEF\bF:\b:_\b<_\bv_\bn_\ba_\bm_\be_\b>=_\b<_\br_\br_\bd_\bf_\bi_\bl_\be_\b>:_\b<_\bd_\bs_\b-
  10        _\bn_\ba_\bm_\be_\b>:_\b<_\bC_\bF_\b>[:step=_\b<_\bs_\bt_\be_\bp_\b>][:start=_\b<_\bt_\bi_\bm_\be_\b>][:end=_\b<_\bt_\bi_\bm_\be_\b>][:reduce=_\b<_\bC\bC_\bF\bF_\b>]
  11
  12        V\bVD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
  13
  14        C\bCD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
  15
  16 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  17        These three instructions extract data values out of the R\bRR\bRD\bD files,
  18        optionally altering them (think, for example, of a bytes to bits con-
  19        version). If so desired, you can also define variables containing use-
  20        ful information such as maximum, minimum etcetera. Two of the instruc-
  21        tions use a language called R\bRP\bPN\bN which is described in its own manual
  22        page.
  23
  24        Variable names (_\bv_\bn_\ba_\bm_\be) must be made up strings of the following charac-
  25        ters "A-Z, a-z, 0-9, -,_" and a maximum length of 255 characters.
  26
  27        When picking variable names, make sure you do not choose a name that is
  28        already taken by an RPN operator. A safe bet it to use lowercase or
  29        mixedcase names for variables since operators will always be in upper-
  30        case.
  31
  32 D\bDE\bEF\bF
  33        D\bDE\bEF\bF:\b:_\b<_\bv_\bn_\ba_\bm_\be_\b>=_\b<_\br_\br_\bd_\bf_\bi_\bl_\be_\b>:_\b<_\bd_\bs_\b-
  34        _\bn_\ba_\bm_\be_\b>:_\b<_\bC_\bF_\b>[:step=_\b<_\bs_\bt_\be_\bp_\b>][:start=_\b<_\bt_\bi_\bm_\be_\b>][:end=_\b<_\bt_\bi_\bm_\be_\b>][:reduce=_\b<_\bC\bC_\bF\bF_\b>]
  35
  36        This command fetches data from an R\bRR\bRD\bD file.  The virtual name _\bv_\bn_\ba_\bm_\be can
  37        then be used throughout the rest of the script. By default, an R\bRR\bRA\bA
  38        which contains the correct consolidated data at an appropriate resolu-
  39        tion will be chosen.  The resolution can be overridden with the --step
  40        option.  The resolution can again be overridden by specifying the s\bst\bte\bep\bp
  41        s\bsi\biz\bze\be.  The time span of this data is the same as for the graph by
  42        default, you can override this by specifying s\bst\bta\bar\brt\bt a\ban\bnd\bd e\ben\bnd\bd.  Remember
  43        to escape colons in the time specification!
  44
  45        If the resolution of the data is higher than the resolution of the
  46        graph, the data will be further consolidated. This may result in a
  47        graph that spans slightly more time than requested.  Ideally each point
  48        in the graph should correspond with one C\bCD\bDP\bP from an R\bRR\bRA\bA.  For instance,
  49        if your R\bRR\bRD\bD has an R\bRR\bRA\bA with a resolution of 1800 seconds per C\bCD\bDP\bP, you
  50        should create an image with width 400 and time span 400*1800 seconds
  51        (use appropriate start and end times, such as "--start
  52        end-8days8hours").
  53
  54        If consolidation needs to be done, the C\bCF\bF of the R\bRR\bRA\bA specified in the
  55        D\bDE\bEF\bF itself will be used to reduce the data density. This behaviour can
  56        be changed using ":reduce=<CF>".  This optional parameter specifies the
  57        C\bCF\bF to use during the data reduction phase.
  58
  59        Example:
  60
  61                DEF:ds0=router.rrd:ds0:AVERAGE
  62                DEF:ds0weekly=router.rrd:ds0:AVERAGE:step=7200
  63                DEF:ds0weekly=router.rrd:ds0:AVERAGE:start=end-1h
  64                DEF:ds0weekly=router.rrd:ds0:AVERAGE:start=11\:00:end=start+1h
  65
  66 V\bVD\bDE\bEF\bF
  67        V\bVD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
  68
  69        This command returns a value and/or a time according to the R\bRP\bPN\bN state-
  70        ments used. The resulting _\bv_\bn_\ba_\bm_\be will, depending on the functions used,
  71        have a value and a time component.  When you use this _\bv_\bn_\ba_\bm_\be in another
  72        R\bRP\bPN\bN expression, you are effectively inserting its value just as if you
  73        had put a number at that place.  The variable can also be used in the
  74        various graph and print elements.
  75
  76        Example: "VDEF:avg=mydata,AVERAGE"
  77
  78        Note that currently only aggregation functions work in VDEF rpn expres-
  79        sions.  Patches to change this are welcome.
  80
  81 C\bCD\bDE\bEF\bF
  82        C\bCD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
  83
  84        This command creates a new set of data points (in memory only, not in
  85        the R\bRR\bRD\bD file) out of one or more other data series. The R\bRP\bPN\bN instruc-
  86        tions are used to evaluate a mathematical function on each data point.
  87        The resulting _\bv_\bn_\ba_\bm_\be can then be used further on in the script, just as
  88        if it were generated by a D\bDE\bEF\bF instruction.
  89
  90        Example: "CDEF:mydatabits=mydata,8,*"
  91
  92 A\bAb\bbo\bou\but\bt C\bCD\bDE\bEF\bF v\bve\ber\brs\bsu\bus\bs V\bVD\bDE\bEF\bF
  93        At some point in processing, R\bRR\bRD\bDt\bto\boo\bol\bl has gathered an array of rates
  94        ready to display.
  95
  96        C\bCD\bDE\bEF\bF works on such an array.  For example, _\bC_\bD_\bE_\bF_\b:_\bn_\be_\bw_\b=_\bd_\bs_\b0_\b,_\b8_\b,_\b* would mul-
  97        tiply each of the array members by eight (probably transforming bytes
  98        into bits). The result is an array containing the new values.
  99
 100        V\bVD\bDE\bEF\bF also works on such an array but in a different way.  For example,
 101        _\bV_\bD_\bE_\bF_\b:_\bm_\ba_\bx_\b=_\bd_\bs_\b0_\b,_\bM_\bA_\bX_\bI_\bM_\bU_\bM would scan each of the array members and store the
 102        maximum value.
 103
 104        W\bWh\bhe\ben\bn d\bdo\bo y\byo\bou\bu u\bus\bse\be V\bVD\bDE\bEF\bF v\bve\ber\brs\bsu\bus\bs C\bCD\bDE\bEF\bF?\b?
 105
 106        Use C\bCD\bDE\bEF\bF to transform your data prior to graphing.  In the above exam-
 107        ple, we'd use a C\bCD\bDE\bEF\bF to transform bytes to bits before graphing the
 108        bits.
 109
 110        You use a V\bVD\bDE\bEF\bF if you want _\bm_\ba_\bx_\b(_\b1_\b,_\b5_\b,_\b3_\b,_\b2_\b,_\b4_\b) to return five which would be
 111        displayed in the graph's legend (to answer, what was the maximum value
 112        during the graph period).
 113
 114        If you want to apply 'complex' operations to the result of a VDEF you
 115        have to use a CDEF again since VDEFs only look like RPN expressions,
 116        they aren't realy.
 117
 118 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 119        rrdgraph gives an overview of how r\brr\brd\bdt\bto\boo\bol\bl g\bgr\bra\bap\bph\bh works.  rrdgraph_data
 120        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
 121        language used in the ?\b?D\bDE\bEF\bF statements.  rrdgraph_graph page describes
 122        all of the graph and print functions.
 123
 124        Make sure to read rrdgraph_examples for tips&tricks.
 125
 126 A\bAU\bUT\bTH\bHO\bOR\bR
 127        Program by Tobias Oetiker <tobi@oetiker.ch>
 128
 129        This manual page by Alex van den Bogaerdt <alex@vandenbogaerdt.nl> with
 130        corrections and/or additions by several people
 131
 132
 133
 134 1.3.99909060808                   2009-04-29                  RRDGRAPH_DATA(1)