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>--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>
  68
  69 <dd>
  70 <p>The name of the <strong>RRD</strong> you want to tune.</p>
  71 </dd>
  72 </li>
  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>
  74
  75 <dd>
  76 <p>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.</p>
  78 </dd>
  79 </li>
  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>
  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 </li>
  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>
  88
  89 <dd>
  90 <p>alter the maximum value acceptable as input from the data source.
  91 Setting <em>max</em> to 'U' will disable this limit.</p>
  92 </dd>
  93 </li>
  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>
  95
  96 <dd>
  97 <p>alter the type <strong>DST</strong> of a data source.</p>
  98 </dd>
  99 </li>
 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>
 101
 102 <dd>
 103 <p>rename a data source.</p>
 104 </dd>
 105 </li>
 106 <dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong>&nbsp;<em>scale-value</em></a></strong>
 107
 108 <dd>
 109 <p>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>.</p>
 116 </dd>
 117 </li>
 118 <dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong>&nbsp;<em>scale-value</em></a></strong>
 119
 120 <dd>
 121 <p>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.</p>
 125 </dd>
 126 </li>
 127 <dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong>&nbsp;<em>failure-threshold</em></a></strong>
 128
 129 <dd>
 130 <p>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.</p>
 135 </dd>
 136 </li>
 137 <dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong>&nbsp;<em>window-length</em></a></strong>
 138
 139 <dd>
 140 <p>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.</p>
 144 </dd>
 145 </li>
 146 <dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong>&nbsp;<em>adaption-parameter</em></a></strong>
 147
 148 <dd>
 149 <p>Alter the intercept adaptation parameter for the Holt-Winters
 150 forecasting algorithm. This parameter must be between 0 and 1.</p>
 151 </dd>
 152 </li>
 153 <dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong>&nbsp;<em>adaption-parameter</em></a></strong>
 154
 155 <dd>
 156 <p>Alter the slope adaptation parameter for the Holt-Winters forecasting
 157 algorithm. This parameter must be between 0 and 1.</p>
 158 </dd>
 159 </li>
 160 <dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong>&nbsp;<em>adaption-parameter</em></a></strong>
 161
 162 <dd>
 163 <p>Alter the seasonal coefficient adaptation parameter for the SEASONAL
 164 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 165 </dd>
 166 </li>
 167 <dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong>&nbsp;<em>adaption-parameter</em></a></strong>
 168
 169 <dd>
 170 <p>Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
 171 <strong>RRA</strong>. This parameter must be between 0 and 1.</p>
 172 </dd>
 173 </li>
 174 <dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong>&nbsp;<em>ds-name</em></a></strong>
 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 <strong>RRA</strong>, it sets the intercept and slope
 180 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
 183 the violation history. Note that reset does not erase past predictions
 184 (the values of the HWPREDICT <strong>RRA</strong>), predicted deviations (the values of the
 185 DEVPREDICT <strong>RRA</strong>), or failure history (the values of the FAILURES <strong>RRA</strong>).
 186 This option will function even if not all the listed <strong>RRAs</strong> are present.</p>
 187 </dd>
 188 <dd>
 189 <p>Due to the implementation of this option, there is an indirect impact on
 190 other data sources in the RRD. A smoothing algorithm is applied to
 191 SEASONAL and DEVSEASONAL values on a periodic basis. During bootstrap
 192 initialization this smoothing is deferred. For efficiency, the implementation
 193 of smoothing is not data source specific. This means that utilizing
 194 reset for one data source will delay running the smoothing algorithm
 195 for all data sources in the file. This is unlikely to have serious
 196 consequences, unless the data being collected for the non-reset data sources
 197 is unusually volatile during the reinitialization period of the reset
 198 data source.</p>
 199 </dd>
 200 <dd>
 201 <p>Use of this tuning option is advised when the behavior of the data source
 202 time series changes in a drastic and permanent manner.</p>
 203 </dd>
 204 </li>
 205 </dl>
 206 <p>
 207 </p>
 208 <hr />
 209 <h1><a name="example_1">EXAMPLE 1</a></h1>
 210 <p><code>rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000</code></p>
 211 <p>Set the minimum required heartbeat for data sources 'in', 'out'
 212 and 'through' to 10'000 seconds which is a little over one day in data.rrd.
 213 This would allow to feed old data from MRTG-2.0 right into
 214 RRDtool without generating *UNKNOWN* entries.</p>
 215 <p>
 216 </p>
 217 <hr />
 218 <h1><a name="example_2">EXAMPLE 2</a></h1>
 219 <p><code>rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3</code></p>
 220 <p>If the FAILURES <strong>RRA</strong> is implicitly created, the default
 221 window-length is 9 and the default failure-threshold is 7. This
 222 command now defines a failure as 3 or more violations in a temporal
 223 window of 5 time points.</p>
 224 <p>
 225 </p>
 226 <hr />
 227 <h1><a name="author">AUTHOR</a></h1>
 228 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 229
 230 </body>
 231
 232 </html>