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