![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdgraph_data.txt b/doc/rrdgraph_data.txt
index 338b264d71437403d3ea7e7583e109d8ebc596d6..a2bc07217c1020ed7e49770abcc16e799b382bb4 100644 (file)
--- a/doc/rrdgraph_data.txt
+++ b/doc/rrdgraph_data.txt
rrdgraph_data - preparing data for graphing in rrdtool graph
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
- 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-
- _\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>]
+ 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-_\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>]
V\bVD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
These three instructions extract data values out of the R\bRR\bRD\bD files,
- optionally altering them (think, for example, of a bytes to bits con-
- version). If so desired, you can also define variables containing use-
- ful information such as maximum, minimum etcetera. Two of the instruc-
- tions use a language called R\bRP\bPN\bN which is described in its own manual
- page.
+ optionally altering them (think, for example, of a bytes to bits
+ conversion). If so desired, you can also define variables containing
+ useful information such as maximum, minimum etcetera. Two of the
+ instructions use a language called R\bRP\bPN\bN which is described in its own
+ manual page.
- Variable names (_\bv_\bn_\ba_\bm_\be) must be made up strings of the following charac-
- ters "A-Z, a-z, 0-9, -,_" and a maximum length of 255 characters.
+ Variable names (_\bv_\bn_\ba_\bm_\be) must be made up strings of the following
+ characters "A-Z, a-z, 0-9, -,_" and a maximum length of 255 characters.
When picking variable names, make sure you do not choose a name that is
already taken by an RPN operator. A safe bet it to use lowercase or
- mixedcase names for variables since operators will always be in upper-
- case.
+ mixedcase names for variables since operators will always be in
+ uppercase.
D\bDE\bEF\bF
- 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-
- _\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>]
+ 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-_\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>]
This command fetches data from an R\bRR\bRD\bD file. The virtual name _\bv_\bn_\ba_\bm_\be can
then be used throughout the rest of the script. By default, an R\bRR\bRA\bA
- which contains the correct consolidated data at an appropriate resolu-
- tion will be chosen. The resolution can be overridden with the --step
- option. The resolution can again be overridden by specifying the s\bst\bte\bep\bp
- s\bsi\biz\bze\be. The time span of this data is the same as for the graph by
- default, you can override this by specifying s\bst\bta\bar\brt\bt a\ban\bnd\bd e\ben\bnd\bd. Remember
- to escape colons in the time specification!
+ which contains the correct consolidated data at an appropriate
+ resolution will be chosen. The resolution can be overridden with the
+ --step option. The resolution can again be overridden by specifying
+ the s\bst\bte\bep\bp s\bsi\biz\bze\be. The time span of this data is the same as for the graph
+ by default, you can override this by specifying s\bst\bta\bar\brt\bt a\ban\bnd\bd e\ben\bnd\bd.
+ Remember to escape colons in the time specification!
If the resolution of the data is higher than the resolution of the
graph, the data will be further consolidated. This may result in a
If consolidation needs to be done, the C\bCF\bF of the R\bRR\bRA\bA specified in the
D\bDE\bEF\bF itself will be used to reduce the data density. This behaviour can
- be changed using ":reduce=<CF>". This optional parameter specifies the
+ be changed using ":reduce=_\b<C\bCF\bF_\b>_\b". This optional parameter specifies the
C\bCF\bF to use during the data reduction phase.
Example:
V\bVD\bDE\bEF\bF
V\bVD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
- This command returns a value and/or a time according to the R\bRP\bPN\bN state-
- ments used. The resulting _\bv_\bn_\ba_\bm_\be will, depending on the functions used,
- have a value and a time component. When you use this _\bv_\bn_\ba_\bm_\be in another
- R\bRP\bPN\bN expression, you are effectively inserting its value just as if you
- had put a number at that place. The variable can also be used in the
- various graph and print elements.
+ This command returns a value and/or a time according to the R\bRP\bPN\bN
+ statements used. The resulting _\bv_\bn_\ba_\bm_\be will, depending on the functions
+ used, have a value and a time component. When you use this _\bv_\bn_\ba_\bm_\be in
+ another R\bRP\bPN\bN expression, you are effectively inserting its value just as
+ if you had put a number at that place. The variable can also be used
+ in the various graph and print elements.
Example: "VDEF:avg=mydata,AVERAGE"
- Note that currently only aggregation functions work in VDEF rpn expres-
- sions. Patches to change this are welcome.
+ Note that currently only aggregation functions work in VDEF rpn
+ expressions. Patches to change this are welcome.
C\bCD\bDE\bEF\bF
C\bCD\bDE\bEF\bF:_\bv_\bn_\ba_\bm_\be=_\bR_\bP_\bN _\be_\bx_\bp_\br_\be_\bs_\bs_\bi_\bo_\bn
This command creates a new set of data points (in memory only, not in
- the R\bRR\bRD\bD file) out of one or more other data series. The R\bRP\bPN\bN instruc-
- tions are used to evaluate a mathematical function on each data point.
- The resulting _\bv_\bn_\ba_\bm_\be can then be used further on in the script, just as
- if it were generated by a D\bDE\bEF\bF instruction.
+ the R\bRR\bRD\bD file) out of one or more other data series. The R\bRP\bPN\bN
+ instructions are used to evaluate a mathematical function on each data
+ point. The resulting _\bv_\bn_\ba_\bm_\be can then be used further on in the script,
+ just as if it were generated by a D\bDE\bEF\bF instruction.
Example: "CDEF:mydatabits=mydata,8,*"
At some point in processing, R\bRR\bRD\bDt\bto\boo\bol\bl has gathered an array of rates
ready to display.
- 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-
- tiply each of the array members by eight (probably transforming bytes
- into bits). The result is an array containing the new values.
+ 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
+ multiply each of the array members by eight (probably transforming
+ bytes into bits). The result is an array containing the new values.
V\bVD\bDE\bEF\bF also works on such an array but in a different way. For example,
_\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
maximum value.
- 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?
-
- Use C\bCD\bDE\bEF\bF to transform your data prior to graphing. In the above exam-
- ple, we'd use a C\bCD\bDE\bEF\bF to transform bytes to bits before graphing the
+ 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?
+ Use C\bCD\bDE\bEF\bF to transform your data prior to graphing. In the above
+ example, we'd use a C\bCD\bDE\bEF\bF to transform bytes to bits before graphing the
bits.
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
-1.3.99909060808 2009-04-29 RRDGRAPH_DATA(1)
+1.3.999 2009-06-01 RRDGRAPH_DATA(1)