doc/rrdtune.txt

   1 RRDTUNE(1)                          rrdtool                         RRDTUNE(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdtune - Modify some basic properties of a Round Robin Database
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        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]
  10        [-\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]
  11        [-\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-
  12        _\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]
  13        [-\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]
  14        [-\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]
  15        [-\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]
  16        [-\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]
  17        [-\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-
  18        _\bn_\ba_\bm_\be]
  19
  20 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  21        The tune option allows you to alter some of the basic configuration
  22        values stored in the header area of a Round Robin Database (R\bRR\bRD\bD).
  23
  24        One application of the t\btu\bun\bne\be function is to relax the validation rules
  25        on an R\bRR\bRD\bD. This allows to fill a new R\bRR\bRD\bD with data available in larger
  26        intervals than what you would normally want to permit. Be very careful
  27        with tune operations for COMPUTE data sources.  Setting the _\bm_\bi_\bn, _\bm_\ba_\bx,
  28        and  _\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt for a COMPUTE data source without changing the data
  29        source type to a non-COMPUTE D\bDS\bST\bT WILL corrupt the data source header in
  30        the R\bRR\bRD\bD.
  31
  32        A second application of the t\btu\bun\bne\be function is to set or alter parameters
  33        used by the specialized function R\bRR\bRA\bAs\bs for aberrant behavior detection.
  34
  35        _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
  36                The name of the R\bRR\bRD\bD you want to tune.
  37
  38        -\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
  39                modify the _\bh_\be_\ba_\br_\bt_\bb_\be_\ba_\bt of a data source. By setting this to a
  40                high value the RRD will accept things like one value per day.
  41
  42        -\b--\b-m\bmi\bin\bni\bim\bmu\bum\bm|-\b-i\bi _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\bi_\bn
  43                alter the minimum value acceptable as input from the data
  44                source.  Setting _\bm_\bi_\bn to 'U' will disable this limit.
  45
  46        -\b--\b-m\bma\bax\bxi\bim\bmu\bum\bm|-\b-a\ba _\bd_\bs_\b-_\bn_\ba_\bm_\be:_\bm_\ba_\bx
  47                alter the maximum value acceptable as input from the data
  48                source.  Setting _\bm_\ba_\bx to 'U' will disable this limit.
  49
  50        -\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
  51                alter the type D\bDS\bST\bT of a data source.
  52
  53        -\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
  54                rename a data source.
  55
  56        -\b--\b-d\bde\bel\blt\bta\bap\bpo\bos\bs _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be
  57                Alter the deviation scaling factor for the upper bound of the
  58                confidence band used internally to calculate violations for the
  59                FAILURES R\bRR\bRA\bA. The default value is 2. Note that this parameter
  60                is not related to graphing confidence bounds which must be
  61                specified as a CDEF argument to generate a graph with
  62                confidence bounds. The graph scale factor need not to agree
  63                with the value used internally by the FAILURES R\bRR\bRA\bA.
  64
  65        -\b--\b-d\bde\bel\blt\bta\ban\bne\beg\bg _\bs_\bc_\ba_\bl_\be_\b-_\bv_\ba_\bl_\bu_\be
  66                Alter the deviation scaling factor for the lower bound of the
  67                confidence band used internally to calculate violations for the
  68                FAILURES R\bRR\bRA\bA. The default value is 2. As with -\b--\b-d\bde\bel\blt\bta\bap\bpo\bos\bs, this
  69                argument is unrelated to the scale factor chosen when graphing
  70                confidence bounds.
  71
  72        -\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
  73                Alter the number of confidence bound violations that constitute
  74                a failure for purposes of the FAILURES R\bRR\bRA\bA. This must be an
  75                integer less than or equal to the window length of the FAILURES
  76                R\bRR\bRA\bA. This restriction is not verified by the tune option, so
  77                one can reset failure-threshold and window-length
  78                simultaneously. Setting this option will reset the count of
  79                violations to 0.
  80
  81        -\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
  82                Alter the number of time points in the temporal window for
  83                determining failures. This must be an integer greater than or
  84                equal to the window length of the FAILURES R\bRR\bRA\bA and less than or
  85                equal to 28. Setting this option will reset the count of
  86                violations to 0.
  87
  88        -\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
  89                Alter the intercept adaptation parameter for the Holt-Winters
  90                forecasting algorithm. This parameter must be between 0 and 1.
  91
  92        -\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
  93                Alter the slope adaptation parameter for the Holt-Winters
  94                forecasting algorithm. This parameter must be between 0 and 1.
  95
  96        -\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
  97                Alter the seasonal coefficient adaptation parameter for the
  98                SEASONAL R\bRR\bRA\bA. This parameter must be between 0 and 1.
  99
 100        -\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
 101                Alter the seasonal deviation adaptation parameter for the
 102                DEVSEASONAL R\bRR\bRA\bA. This parameter must be between 0 and 1.
 103
 104        -\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
 105                Alter the size of the smoothing window for the SEASONAL R\bRR\bRA\bA.
 106                This must be between 0 and 1.
 107
 108        -\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
 109                Alter the size of the smoothing window for the DEVSEASONAL R\bRR\bRA\bA.
 110                This must be between 0 and 1.
 111
 112        -\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
 113                This option causes the aberrant behavior detection algorithm to
 114                reset for the specified data source; that is, forget all it is
 115                has learnt so far.  Specifically, for the HWPREDICT or
 116                MHWPREDICT R\bRR\bRA\bA, it sets the intercept and slope coefficients to
 117                unknown. For the SEASONAL R\bRR\bRA\bA, it sets all seasonal
 118                coefficients to unknown. For the DEVSEASONAL R\bRR\bRA\bA, it sets all
 119                seasonal deviation coefficients to unknown. For the FAILURES
 120                R\bRR\bRA\bA, it erases the violation history. Note that reset does not
 121                erase past predictions (the values of the HWPREDICT or
 122                MHWPREDICT R\bRR\bRA\bA), predicted deviations (the values of the
 123                DEVPREDICT R\bRR\bRA\bA), or failure history (the values of the FAILURES
 124                R\bRR\bRA\bA).  This option will function even if not all the listed
 125                R\bRR\bRA\bAs\bs are present.
 126
 127                Due to the implementation of this option, there is an indirect
 128                impact on other data sources in the RRD. A smoothing algorithm
 129                is applied to SEASONAL and DEVSEASONAL values on a periodic
 130                basis. During bootstrap initialization this smoothing is
 131                deferred. For efficiency, the implementation of smoothing is
 132                not data source specific. This means that utilizing reset for
 133                one data source will delay running the smoothing algorithm for
 134                all data sources in the file. This is unlikely to have serious
 135                consequences, unless the data being collected for the non-reset
 136                data sources is unusually volatile during the reinitialization
 137                period of the reset data source.
 138
 139                Use of this tuning option is advised when the behavior of the
 140                data source time series changes in a drastic and permanent
 141                manner.
 142
 143 E\bEX\bXA\bAM\bMP\bPL\bLE\bE 1\b1
 144        "rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000"
 145
 146        Set the minimum required heartbeat for data sources 'in', 'out' and
 147        'through' to 10'000 seconds which is a little over one day in data.rrd.
 148        This would allow to feed old data from MRTG-2.0 right into RRDtool
 149        without generating *UNKNOWN* entries.
 150
 151 E\bEX\bXA\bAM\bMP\bPL\bLE\bE 2\b2
 152        "rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3"
 153
 154        If the FAILURES R\bRR\bRA\bA is implicitly created, the default window-length is
 155        9 and the default failure-threshold is 7. This command now defines a
 156        failure as 3 or more violations in a temporal window of 5 time points.
 157
 158 A\bAU\bUT\bTH\bHO\bOR\bR
 159        Tobias Oetiker <tobi@oetiker.ch>
 160
 161
 162
 163 1.4.8                             2013-05-23                        RRDTUNE(1)