doc/rrdtune.html

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