


     RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))             1111....2222....11113333 ((((2222000000006666----00005555----00004444))))             RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))



     NNNNAAAAMMMMEEEE
          rrdtune - Modify some basic properties of a Round Robin
          Database

     SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
          rrrrrrrrddddttttoooooooollll ttttuuuunnnneeee _f_i_l_e_n_a_m_e [--------hhhheeeeaaaarrrrttttbbbbeeeeaaaatttt|----hhhh _d_s-_n_a_m_e:_h_e_a_r_t_b_e_a_t]
          [--------mmmmiiiinnnniiiimmmmuuuummmm|----iiii _d_s-_n_a_m_e:_m_i_n] [--------mmmmaaaaxxxxiiiimmmmuuuummmm|----aaaa _d_s-_n_a_m_e:_m_a_x]
          [--------ddddaaaattttaaaa----ssssoooouuuurrrrcccceeee----ttttyyyyppppeeee|----dddd _d_s-_n_a_m_e:_D_S_T]
          [--------ddddaaaattttaaaa----ssssoooouuuurrrrcccceeee----rrrreeeennnnaaaammmmeeee|----rrrr _o_l_d-_n_a_m_e:_n_e_w-_n_a_m_e]
          [--------ddddeeeellllttttaaaappppoooossss _s_c_a_l_e-_v_a_l_u_e] [--------ddddeeeellllttttaaaannnneeeegggg _s_c_a_l_e-_v_a_l_u_e]
          [--------ffffaaaaiiiilllluuuurrrreeee----tttthhhhrrrreeeesssshhhhoooolllldddd _f_a_i_l_u_r_e-_t_h_r_e_s_h_o_l_d]
          [--------wwwwiiiinnnnddddoooowwww----lllleeeennnnggggtttthhhh _w_i_n_d_o_w-_l_e_n_g_t_h] [--------aaaallllpppphhhhaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r]
          [--------bbbbeeeettttaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r] [--------ggggaaaammmmmmmmaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r]
          [--------ggggaaaammmmmmmmaaaa----ddddeeeevvvviiiiaaaattttiiiioooonnnn _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r]
          [--------aaaabbbbeeeerrrrrrrraaaannnntttt----rrrreeeesssseeeetttt _d_s-_n_a_m_e]

     DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
          The tune option allows you to alter some of the basic
          configuration values stored in the header area of a Round
          Robin Database (RRRRRRRRDDDD).

          One application of the ttttuuuunnnneeee function is to relax the
          validation rules on an RRRRRRRRDDDD. This allows to fill a new RRRRRRRRDDDD
          with data available in larger intervals than what you would
          normally want to permit. Be very careful with tune
          operations for COMPUTE data sources.  Setting the _m_i_n, _m_a_x,
          and  _h_e_a_r_t_b_e_a_t for a COMPUTE data source without changing
          the data source type to a non-COMPUTE DDDDSSSSTTTT WILL corrupt the
          data source header in the RRRRRRRRDDDD.

          A second application of the ttttuuuunnnneeee function is to set or alter
          parameters used by the specialized function RRRRRRRRAAAAssss for
          aberrant behavior detection.

          _f_i_l_e_n_a_m_e
                  The name of the RRRRRRRRDDDD you want to tune.

          --hhhheeeeaaaarrrrttttbbbbeeeeaaaatttt|-hhhh _d_s-_n_a_m_e:_h_e_a_r_t_b_e_a_t
                  modify the _h_e_a_r_t_b_e_a_t of a data source. By setting
                  this to a high value the RRD will accept things like
                  one value per day.

          --mmmmiiiinnnniiiimmmmuuuummmm|-iiii _d_s-_n_a_m_e:_m_i_n
                  alter the minimum value acceptable as input from the
                  data source.  Setting _m_i_n to 'U' will disable this
                  limit.

          --mmmmaaaaxxxxiiiimmmmuuuummmm|-aaaa _d_s-_n_a_m_e:_m_a_x
                  alter the maximum value acceptable as input from the
                  data source.  Setting _m_a_x to 'U' will disable this
                  limit.




     Page 1                                          (printed 6/13/06)






     RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))             1111....2222....11113333 ((((2222000000006666----00005555----00004444))))             RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))



          --ddddaaaattttaaaa-ssssoooouuuurrrrcccceeee-ttttyyyyppppeeee|-dddd _d_s-_n_a_m_e:_D_S_T
                  alter the type DDDDSSSSTTTT of a data source.

          --ddddaaaattttaaaa-ssssoooouuuurrrrcccceeee-rrrreeeennnnaaaammmmeeee|-rrrr _o_l_d-_n_a_m_e:_n_e_w-_n_a_m_e
                  rename a data source.

          --ddddeeeellllttttaaaappppoooossss _s_c_a_l_e-_v_a_l_u_e
                  Alter the deviation scaling factor for the upper
                  bound of the confidence band used internally to
                  calculate violations for the FAILURES RRRRRRRRAAAA. 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 confidence bounds. The graph scale factor need
                  not to agree with the value used internally by the
                  FAILURES RRRRRRRRAAAA.

          --ddddeeeellllttttaaaannnneeeegggg _s_c_a_l_e-_v_a_l_u_e
                  Alter the deviation scaling factor for the lower
                  bound of the confidence band used internally to
                  calculate violations for the FAILURES RRRRRRRRAAAA. The
                  default value is 2. As with --------ddddeeeellllttttaaaappppoooossss, this
                  argument is unrelated to the scale factor chosen
                  when graphing confidence bounds.

          --ffffaaaaiiiilllluuuurrrreeee-tttthhhhrrrreeeesssshhhhoooolllldddd _f_a_i_l_u_r_e-_t_h_r_e_s_h_o_l_d
                  Alter the number of confidence bound violations that
                  constitute a failure for purposes of the FAILURES
                  RRRRRRRRAAAA. This must be an integer less than or equal to
                  the window length of the FAILURES RRRRRRRRAAAA. This
                  restriction is not verified by the tune option, so
                  one can reset failure-threshold and window-length
                  simultaneously. Setting this option will reset the
                  count of violations to 0.

          --wwwwiiiinnnnddddoooowwww-lllleeeennnnggggtttthhhh _w_i_n_d_o_w-_l_e_n_g_t_h
                  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RRRRRRRAAAA and less than or equal to 28.
                  Setting this option will reset the count of
                  violations to 0.

          --aaaallllpppphhhhaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r
                  Alter the intercept adaptation parameter for the
                  Holt-Winters forecasting algorithm. This parameter
                  must be between 0 and 1.

          --bbbbeeeettttaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r
                  Alter the slope adaptation parameter for the Holt-
                  Winters forecasting algorithm. This parameter must
                  be between 0 and 1.



     Page 2                                          (printed 6/13/06)






     RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))             1111....2222....11113333 ((((2222000000006666----00005555----00004444))))             RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))



          --ggggaaaammmmmmmmaaaa _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r
                  Alter the seasonal coefficient adaptation parameter
                  for the SEASONAL RRRRRRRRAAAA. This parameter must be between
                  0 and 1.

          --ggggaaaammmmmmmmaaaa-ddddeeeevvvviiiiaaaattttiiiioooonnnn _a_d_a_p_t_i_o_n-_p_a_r_a_m_e_t_e_r
                  Alter the seasonal deviation adaptation parameter
                  for the DEVSEASONAL RRRRRRRRAAAA. This parameter must be
                  between 0 and 1.

          --aaaabbbbeeeerrrrrrrraaaannnntttt-rrrreeeesssseeeetttt _d_s-_n_a_m_e
                  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 RRRRRRRRAAAA, it sets the
                  intercept and slope coefficients to unknown. For the
                  SEASONAL RRRRRRRRAAAA, it sets all seasonal coefficients to
                  unknown. For the DEVSEASONAL RRRRRRRRAAAA, it sets all
                  seasonal deviation coefficients to unknown. For the
                  FAILURES RRRRRRRRAAAA, it erases the violation history. Note
                  that reset does not erase past predictions (the
                  values of the HWPREDICT RRRRRRRRAAAA), predicted deviations
                  (the values of the DEVPREDICT RRRRRRRRAAAA), or failure
                  history (the values of the FAILURES RRRRRRRRAAAA).  This
                  option will function even if not all the listed RRRRRRRRAAAAssss
                  are present.

                  Due to the implementation of this option, there is
                  an indirect impact on other data sources in the RRD.
                  A smoothing algorithm is applied to SEASONAL and
                  DEVSEASONAL values on a periodic basis. During
                  bootstrap initialization this smoothing is deferred.
                  For efficiency, the implementation of smoothing is
                  not data source specific. This means that utilizing
                  reset for one data source will delay running the
                  smoothing algorithm for all data sources in the
                  file. This is unlikely to have serious consequences,
                  unless the data being collected for the non-reset
                  data sources is unusually volatile during the
                  reinitialization 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 manner.

     EEEEXXXXAAAAMMMMPPPPLLLLEEEE 1111
          "rrdtool tune data.rrd -h in:100000 -h out:100000 -h
          through:100000"

          Set the minimum required heartbeat for data sources 'in',
          'out' and 'through' to 10'000 seconds which is a little over
          one day in data.rrd.  This would allow to feed old data from



     Page 3                                          (printed 6/13/06)






     RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))             1111....2222....11113333 ((((2222000000006666----00005555----00004444))))             RRRRRRRRDDDDTTTTUUUUNNNNEEEE((((1111))))



          MRTG-2.0 right into RRDtool without generating *UNKNOWN*
          entries.

     EEEEXXXXAAAAMMMMPPPPLLLLEEEE 2222
          "rrdtool tune monitor.rrd --window-length 5
          --failure-threshold 3"

          If the FAILURES RRRRRRRRAAAA is implicitly created, the default
          window-length is 9 and the default failure-threshold is 7.
          This command now defines a failure as 3 or more violations
          in a temporal window of 5 time points.

     AAAAUUUUTTTTHHHHOOOORRRR
          Tobias Oetiker <tobi@oetiker.ch>









































     Page 4                                          (printed 6/13/06)



