doc/rrdtune.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>rrdtune</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body style="background-color: white">
  11
  12 <p><a name="__index__"></a></p>
  13 <!-- INDEX BEGIN -->
  14 <!--
  15
  16 <ul>
  17
  18         <li><a href="#name">NAME</a></li>
  19         <li><a href="#synopsis">SYNOPSIS</a></li>
  20         <li><a href="#description">DESCRIPTION</a></li>
  21         <li><a href="#example_1">EXAMPLE 1</a></li>
  22         <li><a href="#example_2">EXAMPLE 2</a></li>
  23         <li><a href="#author">AUTHOR</a></li>
  24 </ul>
  25 -->
  26 <!-- INDEX END -->
  27
  28 <p>
  29 </p>
  30 <h1><a name="name">NAME</a></h1>
  31 <p>rrdtune - Modify some basic properties of a Round Robin Database</p>
  32 <p>
  33 </p>
  34 <hr />
  35 <h1><a name="synopsis">SYNOPSIS</a></h1>
  36 <p><strong>rrdtool</strong> <strong>tune</strong> <em>filename</em>
  37 [<strong>--heartbeat</strong>|<strong>-h</strong>&nbsp;<em>ds-name</em>:<em>heartbeat</em>]
  38 [<strong>--minimum</strong>|<strong>-i</strong>&nbsp;<em>ds-name</em>:<em>min</em>]
  39 [<strong>--maximum</strong>|<strong>-a</strong>&nbsp;<em>ds-name</em>:<em>max</em>]
  40 [<strong>--data-source-type</strong>|<strong>-d</strong>&nbsp;<em>ds-name</em>:<em>DST</em>]
  41 [<strong>--data-source-rename</strong>|<strong>-r</strong>&nbsp;<em>old-name</em>:<em>new-name</em>]
  42 [<strong>--deltapos</strong>&nbsp;<em>scale-value</em>]
  43 [<strong>--deltaneg</strong>&nbsp;<em>scale-value</em>]
  44 [<strong>--failure-threshold</strong>&nbsp;<em>failure-threshold</em>]
  45 [<strong>--window-length</strong>&nbsp;<em>window-length</em>]
  46 [<strong>--alpha</strong>&nbsp;<em>adaption-parameter</em>]
  47 [<strong>--beta</strong>&nbsp;<em>adaption-parameter</em>]
  48 [<strong>--gamma</strong>&nbsp;<em>adaption-parameter</em>]
  49 [<strong>--gamma-deviation</strong>&nbsp;<em>adaption-parameter</em>]
  50 [<strong>--smoothing-window</strong>&nbsp;<em>fraction-of-season</em>]
  51 [<strong>--smoothing-window-deviation</strong>&nbsp;<em>fraction-of-season</em>]
  52 [<strong>--aberrant-reset</strong>&nbsp;<em>ds-name</em>]</p>
  53 <p>
  54 </p>
  55 <hr />
  56 <h1><a name="description">DESCRIPTION</a></h1>
  57 <p>The tune option allows you to alter some of the basic configuration
  58 values stored in the header area of a Round Robin Database (<strong>RRD</strong>).</p>
  59 <p>One application of the <strong>tune</strong> function is to relax the
  60 validation rules on an <strong>RRD</strong>. This allows to fill a new <strong>RRD</strong> with
  61 data available in larger intervals than what you would normally want
  62 to permit. Be very careful with tune operations for COMPUTE data sources.
  63 Setting the <em>min</em>, <em>max</em>, and  <em>heartbeat</em> for a COMPUTE data source
  64 without changing the data source type to a non-COMPUTE <strong>DST</strong> WILL corrupt
  65 the data source header in the <strong>RRD</strong>.</p>
  66 <p>A second application of the <strong>tune</strong> function is to set or alter parameters
  67 used by the specialized function <strong>RRAs</strong> for aberrant behavior detection.</p>
  68 <dl>
  69 <dt><strong><a name="item_filename"><em>filename</em></a></strong></dt>
  70
  71 <dd>
  72 <p>The name of the <strong>RRD</strong> you want to tune.</p>
  73 </dd>
  74 <dt><strong><a name="item__2d_2dheartbeat_7c_2dh_ds_2dname_3aheartbeat"><strong>--heartbeat</strong>|<strong>-h</strong>&nbsp;<em>ds-name</em>:<em>heartbeat</em></a></strong></dt>
  75
  76 <dd>
  77 <p>modify the <em>heartbeat</em> of a data source. By setting this to a high
  78 value the RRD will accept things like one value per day.</p>
  79 </dd>
  80 <dt><strong><a name="item__2d_2dminimum_7c_2di_ds_2dname_3amin"><strong>--minimum</strong>|<strong>-i</strong>&nbsp;<em>ds-name</em>:<em>min</em></a></strong></dt>
  81
  82 <dd>
  83 <p>alter the minimum value acceptable as input from the data source.
  84 Setting <em>min</em> to 'U' will disable this limit.</p>
  85 </dd>
  86 <dt><strong><a name="item__2d_2dmaximum_7c_2da_ds_2dname_3amax"><strong>--maximum</strong>|<strong>-a</strong>&nbsp;<em>ds-name</em>:<em>max</em></a></strong></dt>
  87
  88 <dd>
  89 <p>alter the maximum value acceptable as input from the data source.
  90 Setting <em>max</em> to 'U' will disable this limit.</p>
  91 </dd>
  92 <dt><strong><a name="item__2d_2ddata_2dsource_2dtype_7c_2dd_ds_2dname_3adst"><strong>--data-source-type</strong>|<strong>-d</strong>&nbsp;<em>ds-name</em>:<em>DST</em></a></strong></dt>
  93
  94 <dd>
  95 <p>alter the type <strong>DST</strong> of a data source.</p>
  96 </dd>
  97 <dt><strong><a name="item__2d_2ddata_2dsource_2drename_7c_2dr_old_2dname_3an"><strong>--data-source-rename</strong>|<strong>-r</strong>&nbsp;<em>old-name</em>:<em>new-name</em></a></strong></dt>
  98
  99 <dd>
 100 <p>rename a data source.</p>
 101 </dd>
 102 <dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong>&nbsp;<em>scale-value</em></a></strong></dt>
 103
 104 <dd>
 105 <p>Alter the deviation scaling factor for the upper bound of the
 106 confidence band used internally to calculate violations for the
 107 FAILURES <strong>RRA</strong>. The default value is 2. Note that this parameter is
 108 not related to graphing confidence bounds which must be specified as a
 109 CDEF argument to generate a graph with confidence bounds. The graph
 110 scale factor need not to agree with the value used internally by the
 111 FAILURES <strong>RRA</strong>.</p>
 112 </dd>
 113 <dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong>&nbsp;<em>scale-value</em></a></strong></dt>
 114
 115 <dd>
 116 <p>Alter the deviation scaling factor for the lower bound of the confidence band
 117 used internally to calculate violations for the FAILURES <strong>RRA</strong>. The default
 118 value is 2. As with <strong>--deltapos</strong>, this argument is unrelated to the scale
 119 factor chosen when graphing confidence bounds.</p>
 120 </dd>
 121 <dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong>&nbsp;<em>failure-threshold</em></a></strong></dt>
 122
 123 <dd>
 124 <p>Alter the number of confidence bound violations that constitute a failure for
 125 purposes of the FAILURES <strong>RRA</strong>. This must be an integer less than or equal to
 126 the window length of the FAILURES <strong>RRA</strong>. This restriction is not verified by
 127 the tune option, so one can reset failure-threshold and window-length
 128 simultaneously. Setting this option will reset the count of violations to 0.</p>
 129 </dd>
 130 <dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong>&nbsp;<em>window-length</em></a></strong></dt>
 131
 132 <dd>
 133 <p>Alter the number of time points in the temporal window for determining
 134 failures. This must be an integer greater than or equal to the window
 135 length of the FAILURES <strong>RRA</strong> and less than or equal to 28. Setting
 136 this option will reset the count of violations to 0.</p>
 137 </dd>
 138 <dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 139
 140 <dd>
 141 <p>Alter the intercept adaptation parameter for the Holt-Winters
 142 forecasting algorithm. This parameter must be between 0 and 1.</p>
 143 </dd>
 144 <dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 145
 146 <dd>
 147 <p>Alter the slope adaptation parameter for the Holt-Winters forecasting
 148 algorithm. This parameter must be between 0 and 1.</p>
 149 </dd>
 150 <dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 151
 152 <dd>
 153 <p>Alter the seasonal coefficient adaptation parameter for the SEASONAL
 154 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 155 </dd>
 156 <dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong>&nbsp;<em>adaption-parameter</em></a></strong></dt>
 157
 158 <dd>
 159 <p>Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
 160 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 161 </dd>
 162 <dt><strong><a name="item__2d_2dsmoothing_2dwindow_fraction_2dof_2dseason"><strong>--smoothing-window</strong>&nbsp;<em>fraction-of-season</em></a></strong></dt>
 163
 164 <dd>
 165 <p>Alter the size of the smoothing window for the SEASONAL <strong>RRA</strong>. This must
 166 be between 0 and 1.</p>
 167 </dd>
 168 <dt><strong><a name="item__2d_2dsmoothing_2dwindow_2ddeviation_fraction_2dof"><strong>--smoothing-window-deviation</strong>&nbsp;<em>fraction-of-season</em></a></strong></dt>
 169
 170 <dd>
 171 <p>Alter the size of the smoothing window for the DEVSEASONAL <strong>RRA</strong>. This must
 172 be between 0 and 1.</p>
 173 </dd>
 174 <dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong>&nbsp;<em>ds-name</em></a></strong></dt>
 175
 176 <dd>
 177 <p>This option causes the aberrant behavior detection algorithm to reset
 178 for the specified data source; that is, forget all it is has learnt so far.
 179 Specifically, for the HWPREDICT or MHWPREDICT <strong>RRA</strong>, it sets the intercept and
 180 slope coefficients to unknown. For the SEASONAL <strong>RRA</strong>, it sets all seasonal
 181 coefficients to unknown. For the DEVSEASONAL <strong>RRA</strong>, it sets all seasonal
 182 deviation coefficients to unknown. For the FAILURES <strong>RRA</strong>, it erases the
 183 violation history. Note that reset does not erase past predictions
 184 (the values of the HWPREDICT or MHWPREDICT <strong>RRA</strong>), predicted deviations (the
 185 values of the DEVPREDICT <strong>RRA</strong>), or failure history (the values of the
 186 FAILURES <strong>RRA</strong>).  This option will function even if not all the listed
 187 <strong>RRAs</strong> are present.</p>
 188 <p>Due to the implementation of this option, there is an indirect impact on
 189 other data sources in the RRD. A smoothing algorithm is applied to
 190 SEASONAL and DEVSEASONAL values on a periodic basis. During bootstrap
 191 initialization this smoothing is deferred. For efficiency, the implementation
 192 of smoothing is not data source specific. This means that utilizing
 193 reset for one data source will delay running the smoothing algorithm
 194 for all data sources in the file. This is unlikely to have serious
 195 consequences, unless the data being collected for the non-reset data sources
 196 is unusually volatile during the reinitialization period of the reset
 197 data source.</p>
 198 <p>Use of this tuning option is advised when the behavior of the data source
 199 time series changes in a drastic and permanent manner.</p>
 200 </dd>
 201 </dl>
 202 <p>
 203 </p>
 204 <hr />
 205 <h1><a name="example_1">EXAMPLE 1</a></h1>
 206 <p><code>rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000</code></p>
 207 <p>Set the minimum required heartbeat for data sources 'in', 'out'
 208 and 'through' to 10'000 seconds which is a little over one day in data.rrd.
 209 This would allow to feed old data from MRTG-2.0 right into
 210 RRDtool without generating *UNKNOWN* entries.</p>
 211 <p>
 212 </p>
 213 <hr />
 214 <h1><a name="example_2">EXAMPLE 2</a></h1>
 215 <p><code>rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3</code></p>
 216 <p>If the FAILURES <strong>RRA</strong> is implicitly created, the default
 217 window-length is 9 and the default failure-threshold is 7. This
 218 command now defines a failure as 3 or more violations in a temporal
 219 window of 5 time points.</p>
 220 <p>
 221 </p>
 222 <hr />
 223 <h1><a name="author">AUTHOR</a></h1>
 224 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 225
 226 </body>
 227
 228 </html>