![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdtune.txt b/doc/rrdtune.txt
index a3f12c06c7645373e5d7ce99089e94375f262675..6478b5ea05e936f7e44b342e17e4651bed7d3500 100644 (file)
--- a/doc/rrdtune.txt
+++ b/doc/rrdtune.txt
rrdtune - Modify some basic properties of a Round Robin Database
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
- r\brr\brd\bdt\bto\boo\bol\bl t\btu\bun\bne\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\b--\b-h\bhe\bea\bar\brt\btb\bbe\bea\bat\bt|-\b-h\bh _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt] [-\b--\b-m\bmi\bin\bni\bi-\b-
- m\bmu\bum\bm|-\b-i\bi _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\bi_\bn] [-\b--\b-m\bma\bax\bxi\bim\bmu\bum\bm|-\b-a\ba _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\ba_\bx]
+ r\brr\brd\bdt\bto\boo\bol\bl t\btu\bun\bne\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\b--\b-h\bhe\bea\bar\brt\btb\bbe\bea\bat\bt|-\b-h\bh _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt]
+ [-\b--\b-m\bmi\bin\bni\bim\bmu\bum\bm|-\b-i\bi _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\bi_\bn] [-\b--\b-m\bma\bax\bxi\bim\bmu\bum\bm|-\b-a\ba _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\ba_\bx]
[-\b--\b-d\bda\bat\bta\ba-\b-s\bso\bou\bur\brc\bce\be-\b-t\bty\byp\bpe\be|-\b-d\bd _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bD_\bS_\bT] [-\b--\b-d\bda\bat\bta\ba-\b-s\bso\bou\bur\brc\bce\be-\b-r\bre\ben\bna\bam\bme\be|-\b-r\br _\bo_\bl_\bd_\b-
_\bn_\ba_\bm_\be:_\bn_\be_\bw_\b-_\bn_\ba_\bm_\be] [-\b--\b-d\bde\bel\blt\bta\bap\bpo\bos\bs _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be] [-\b--\b-d\bde\bel\blt\bta\ban\bne\beg\bg _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be]
[-\b--\b-f\bfa\bai\bil\blu\bur\bre\be-\b-t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd _\bf_\ba_\bi_\bl_\bu_\br_\be_\b-_\bt_\bh_\br_\be_\bs_\bh_\bo_\bl_\bd] [-\b--\b-w\bwi\bin\bnd\bdo\bow\bw-\b-l\ble\ben\bng\bgt\bth\bh _\bw_\bi_\bn_\bd_\bo_\bw_\b-_\bl_\be_\bn_\bg_\bt_\bh]
- [-\b--\b-a\bal\blp\bph\bha\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-b\bbe\bet\bta\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba _\ba_\bd_\ba_\bp_\b-
- _\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-s\bsm\bmo\boo\bot\bth\bh-\b-
- i\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn] [-\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-
- _\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn] [-\b--\b-a\bab\bbe\ber\brr\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be]
+ [-\b--\b-a\bal\blp\bph\bha\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-b\bbe\bet\bta\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br]
+ [-\b--\b-g\bga\bam\bmm\bma\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br] [-\b--\b-g\bga\bam\bmm\bma\ba-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br]
+ [-\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn]
+ [-\b--\b-s\bsm\bmo\boo\bot\bth\bhi\bin\bng\bg-\b-w\bwi\bin\bnd\bdo\bow\bw-\b-d\bde\bev\bvi\bia\bat\bti\bio\bon\bn _\bf_\br_\ba_\bc_\bt_\bi_\bo_\bn_\b-_\bo_\bf_\b-_\bs_\be_\ba_\bs_\bo_\bn] [-\b--\b-a\bab\bbe\ber\brr\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-
+ _\bn_\ba_\bm_\be]
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
The tune option allows you to alter some of the basic configuration
confidence band used internally to calculate violations for the
FAILURES R\bRR\bRA\bA. The default value is 2. Note that this parameter
is not related to graphing confidence bounds which must be
- specified as a CDEF argument to generate a graph with confi-
- dence bounds. The graph scale factor need not to agree with the
- value used internally by the FAILURES R\bRR\bRA\bA.
+ specified as a CDEF argument to generate a graph with
+ confidence bounds. The graph scale factor need not to agree
+ with the value used internally by the FAILURES R\bRR\bRA\bA.
-\b--\b-d\bde\bel\blt\bta\ban\bne\beg\bg _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be
Alter the deviation scaling factor for the lower bound of the
a failure for purposes of the FAILURES R\bRR\bRA\bA. This must be an
integer less than or equal to the window length of the FAILURES
R\bRR\bRA\bA. This restriction is not verified by the tune option, so
- one can reset failure-threshold and window-length simultane-
- ously. Setting this option will reset the count of violations
- to 0.
+ one can reset failure-threshold and window-length
+ simultaneously. Setting this option will reset the count of
+ violations to 0.
-\b--\b-w\bwi\bin\bnd\bdo\bow\bw-\b-l\ble\ben\bng\bgt\bth\bh _\bw_\bi_\bn_\bd_\bo_\bw_\b-_\bl_\be_\bn_\bg_\bt_\bh
Alter the number of time points in the temporal window for
determining failures. This must be an integer greater than or
equal to the window length of the FAILURES R\bRR\bRA\bA and less than or
- equal to 28. Setting this option will reset the count of viola-
- tions to 0.
+ equal to 28. Setting this option will reset the count of
+ violations to 0.
-\b--\b-a\bal\blp\bph\bha\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br
Alter the intercept adaptation parameter for the Holt-Winters
forecasting algorithm. This parameter must be between 0 and 1.
-\b--\b-b\bbe\bet\bta\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br
- Alter the slope adaptation parameter for the Holt-Winters fore-
- casting algorithm. This parameter must be between 0 and 1.
+ Alter the slope adaptation parameter for the Holt-Winters
+ forecasting algorithm. This parameter must be between 0 and 1.
-\b--\b-g\bga\bam\bmm\bma\ba _\ba_\bd_\ba_\bp_\bt_\bi_\bo_\bn_\b-_\bp_\ba_\br_\ba_\bm_\be_\bt_\be_\br
Alter the seasonal coefficient adaptation parameter for the
-\b--\b-a\bab\bbe\ber\brr\bra\ban\bnt\bt-\b-r\bre\bes\bse\bet\bt _\bd_\bs_\b-_\bn_\ba_\bm_\be
This option causes the aberrant behavior detection algorithm to
reset for the specified data source; that is, forget all it is
- has learnt so far. Specifically, for the HWPREDICT or MHWPRE-
- DICT R\bRR\bRA\bA, it sets the intercept and slope coefficients to
- unknown. For the SEASONAL R\bRR\bRA\bA, it sets all seasonal coeffi-
- cients to unknown. For the DEVSEASONAL R\bRR\bRA\bA, it sets all sea-
- sonal deviation coefficients to unknown. For the FAILURES R\bRR\bRA\bA,
- it erases the violation history. Note that reset does not erase
- past predictions (the values of the HWPREDICT or MHWPREDICT
- R\bRR\bRA\bA), predicted deviations (the values of the DEVPREDICT R\bRR\bRA\bA),
- or failure history (the values of the FAILURES R\bRR\bRA\bA). This
- option will function even if not all the listed R\bRR\bRA\bAs\bs are
- present.
+ has learnt so far. Specifically, for the HWPREDICT or
+ MHWPREDICT R\bRR\bRA\bA, it sets the intercept and slope coefficients to
+ unknown. For the SEASONAL R\bRR\bRA\bA, it sets all seasonal
+ coefficients to unknown. For the DEVSEASONAL R\bRR\bRA\bA, it sets all
+ seasonal deviation coefficients to unknown. For the FAILURES
+ R\bRR\bRA\bA, it erases the violation history. Note that reset does not
+ erase past predictions (the values of the HWPREDICT or
+ MHWPREDICT R\bRR\bRA\bA), predicted deviations (the values of the
+ DEVPREDICT R\bRR\bRA\bA), or failure history (the values of the FAILURES
+ R\bRR\bRA\bA). This option will function even if not all the listed
+ R\bRR\bRA\bAs\bs are present.
Due to the implementation of this option, there is an indirect
impact on other data sources in the RRD. A smoothing algorithm
period of the reset data source.
Use of this tuning option is advised when the behavior of the
- data source time series changes in a drastic and permanent man-
- ner.
+ data source time series changes in a drastic and permanent
+ manner.
E\bEX\bXA\bAM\bMP\bPL\bLE\bE 1\b1
"rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000"
-1.3.99909060808 2008-03-15 RRDTUNE(1)
+1.3.999 2009-04-19 RRDTUNE(1)