_R_R_D_T_U_N_E(1)                           rrdtool                          _R_R_D_T_U_N_E(1)

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

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

DDEESSCCRRIIPPTTIIOON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RRRDD).

     One application of the ttuunnee function is to relax the validation rules on an
     RRRRDD. This allows you to fill a new RRRRDD with data available in larger inter‐
     vals 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DSSTT WILL corrupt the data source header in the RRRRDD.

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

     Still another application is to add or remove data sources (DS)  or  add  /
     remove  or  alter  some aspects of round-robin archives (RRA). These opera‐
     tions are not really done in-place, but rather generate a new RRD file  in‐
     ternally  and  move  it  over the original file. Data is kept intact during
     these operations.  For even more in-depth modifications you may review  the
     ----ssoouurrccee  and  ----tteemmppllaattee options of the ccrreeaattee function which allow you to
     combine multiple RRD files into a new one and which is even more clever  in
     what data it is able to keep or "regenerate".

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

     ----hheeaarrttbbeeaatt|--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miinniimmuumm|--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maaxxiimmuumm|--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.

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

     ----ddaattaa--ssoouurrccee--rreennaammee|--rr _o_l_d_-_n_a_m_e:_n_e_w_-_n_a_m_e
             rename a data source.

     ----ddeellttaappooss|--pp _s_c_a_l_e_-_v_a_l_u_e
             Alter the deviation scaling factor for the upper bound of the  con‐
             fidence  band used internally to calculate violations for the FAIL‐
             URES RRRRA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RRRAA.

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

     ----ffaaiilluurree--tthhrreesshhoolldd|--ff _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RRRAA. This must be an integer
             less than or equal to the window length of the FAILURES  RRRRA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wiinnddooww--lleennggtthh|--ww _w_i_n_d_o_w_-_l_e_n_g_t_h
             Alter  the  number of time points in the temporal window for deter‐
             mining failures. This must be an integer greater than or  equal  to
             the window length of the FAILURES RRRRAA and less than or equal to 28.
             Setting this option will reset the count of violations to 0.

     ----aallpphhaa|--xx _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 fore‐
             casting algorithm. This parameter must be between 0 and 1.

     ----bbeettaa|--yy _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 forecast‐
             ing algorithm. This parameter must be between 0 and 1.

     ----ggaammmmaa|--zz _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 SEA‐
             SONAL RRRRAA. This parameter must be between 0 and 1.

     ----ggaammmmaa--ddeevviiaattiioonn|--vv _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  DEVSEA‐
             SONAL RRRRAA. This parameter must be between 0 and 1.

     ----ssmmooootthhiinngg--wwiinnddooww|--ss _f_r_a_c_t_i_o_n_-_o_f_-_s_e_a_s_o_n
             Alter  the  size of the smoothing window for the SEASONAL RRRRAA. This
             must be between 0 and 1.

     ----ssmmooootthhiinngg--wwiinnddooww--ddeevviiaattiioonn|--SS _f_r_a_c_t_i_o_n_-_o_f_-_s_e_a_s_o_n
             Alter the size of the smoothing window  for  the  DEVSEASONAL  RRRRAA.
             This must be between 0 and 1.

     ----aabbeerrrraanntt--rreesseett|--bb _d_s_-_n_a_m_e
             This option causes the aberrant behavior detection algorithm to re‐
             set  for  the  specified data source; that is, forget all it is has
             learnt so far.  Specifically, for the HWPREDICT or MHWPREDICT  RRRRAA,
             it  sets  the  intercept and slope coefficients to unknown. For the
             SEASONAL RRRRAA, it sets all seasonal coefficients to unknown. For the
             DEVSEASONAL RRRRAA, it sets all seasonal deviation coefficients to un‐
             known. For the FAILURES RRRRAA, it erases the violation history.  Note
             that  reset  does not erase past predictions (the values of the HW‐
             PREDICT or MHWPREDICT RRRRAA), predicted deviations (the values of the
             DEVPREDICT RRRRAA), or failure history (the  values  of  the  FAILURES
             RRRRAA).   This  option  will function even if not all the listed RRRRAAss
             are present.

             Due to the implementation of this option, there is an indirect  im‐
             pact on other data sources in the RRD. A smoothing algorithm is ap‐
             plied  to SEASONAL and DEVSEASONAL values on a periodic basis. Dur‐
             ing bootstrap initialization this smoothing is deferred. For  effi‐
             ciency,  the  implementation  of  smoothing is not data source spe‐
             cific. This means that utilizing reset for one data source will de‐
             lay 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.

     ----sstteepp|--tt _n_e_w_s_t_e_p
             Changes the step size of the RRD to newstep.

             TODO: add proper documentation

     ----ddaaeemmoonn|--DD _a_d_d_r_e_s_s
             NNOOTTEE:  Because  the --dd (small letter 'd') option was already taken,
             this function (unlike most other) uses the capital letter  'D'  for
             the one-letter option to name the cache daemon.

             If  given,  RRRRDDttooooll  will try to connect to the caching daemon rrd‐
             cached at _a_d_d_r_e_s_s and will fail if the connection cannot be  estab‐
             lished.  If the connection is successfully established the data for
             the _f_i_l_e_n_a_m_e will be flushed before performing the copy/modify  op‐
             eration.  Afterwards  the  _f_i_l_e_n_a_m_e  will be forgotten by the cache
             daemon, so that the next access using the caching daemon will  read
             the proper structure.

             This  sequence  of  operations  is designed to achieve a consistent
             overall result with respect to RRD internal file  consistency  when
             using  one  of  the DDSS or RRRRAA changing operations (that is: the re‐
             sulting file should always be a valid RRD file, regardless of  con‐
             current  updates  through the caching daemon).  Regarding data con‐
             sistency such guarantees are not made:  Without  external  synchro‐
             nization concurrent updates may be lost.

             For  a list of accepted formats, see the --ll option in the rrdcached
             manual.

     DDEELL::_d_s_-_n_a_m_e
             Every data source named with a DEL specification will  be  removed.
             The  resulting  RRD  will miss both the definition and the data for
             that data source. Multiple DEL specifications are permitted.

     DDSS::_d_s_-_s_p_e_c
             For every such data source definition (for the exact syntax see the
             ccrreeaattee command), a new data source will be added to the RRD. Multi‐
             ple DS specifications are permitted.

     DDEELLRRRRAA::_i_n_d_e_x
             Removes the RRA with index _i_n_d_e_x. The index is zero-based, that  is
             the very first RRA has index 0.

     RRRRAA::_r_r_a_-_s_p_e_c
             For  every  such  archive  definition (for the exact syntax see the
             ccrreeaattee command), a new RRA will be added to the output RRD.  Multi‐
             ple RRA specifications are permitted.

     RRRRAA##_i_n_d_e_x:[+-=]<number>
             Adds/removes  or sets the given number of rows for the RRA with in‐
             dex <index>. The index is zero-based, that is the  very  first  RRA
             has index 0.

EEXXAAMMPPLLEE 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 100'000 seconds which is a little over one  day  in  data.rrd.
     This  would allow to feed old data from MRTG-2.0 right into RRDtool without
     generating *UNKNOWN* entries.

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

     If the FAILURES RRRRA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.

EEXXAAMMPPLLEE 33
     "rrdtool tune some.rrd DEL:a RRA#0:+10"

     Delete the data source named aa and extend the  very  first  archive  by  10
     rows.   This  will in fact replace the input RRD with a new RRD keeping all
     existing data.  For most practical use cases this is identical  to  a  real
     in-place modification.

AAUUTTHHOORRSS
     Tobias Oetiker <tobi@oetiker.ch>, Peter Stamfest <peter@stamfest.at>

1.10.0                             2026-05-23                         _R_R_D_T_U_N_E(1)
