![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdtune.html b/doc/rrdtune.html
index ea6baad9ae45e3acbe86af32e873e6caa1f792ec..feeba0d7fa11411c8ea2e6be772660abbc6848d1 100644 (file)
--- a/doc/rrdtune.html
+++ b/doc/rrdtune.html
+<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>rrdtune</title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
-<p><a name="__index__"></a></p>
+
<!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
<!--
<ul>
<li><a href="#example_2">EXAMPLE 2</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
+
-->
+
+
+</div>
<!-- INDEX END -->
<p>
<p>A second application of the <strong>tune</strong> function is to set or alter parameters
used by the specialized function <strong>RRAs</strong> for aberrant behavior detection.</p>
<dl>
-<dt><strong><a name="item_filename"><em>filename</em></a></strong><br />
-</dt>
+<dt><strong><a name="filename" class="item"><em>filename</em></a></strong></dt>
+
<dd>
-The name of the <strong>RRD</strong> you want to tune.
+<p>The name of the <strong>RRD</strong> you want to tune.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dheartbeat_7c_2dh_ds_2dname_3aheartbeat"><strong>--heartbeat</strong>|<strong>-h</strong> <em>ds-name</em>:<em>heartbeat</em></a></strong><br />
-</dt>
+<dt><strong><a name="heartbeat_h_ds_name_heartbeat" class="item"><strong>--heartbeat</strong>|<strong>-h</strong> <em>ds-name</em>:<em>heartbeat</em></a></strong></dt>
+
<dd>
-modify the <em>heartbeat</em> of a data source. By setting this to a high
-value the RRD will accept things like one value per day.
+<p>modify the <em>heartbeat</em> of a data source. By setting this to a high
+value the RRD will accept things like one value per day.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dminimum_7c_2di_ds_2dname_3amin"><strong>--minimum</strong>|<strong>-i</strong> <em>ds-name</em>:<em>min</em></a></strong><br />
-</dt>
+<dt><strong><a name="minimum_i_ds_name_min" class="item"><strong>--minimum</strong>|<strong>-i</strong> <em>ds-name</em>:<em>min</em></a></strong></dt>
+
<dd>
-alter the minimum value acceptable as input from the data source.
-Setting <em>min</em> to 'U' will disable this limit.
+<p>alter the minimum value acceptable as input from the data source.
+Setting <em>min</em> to 'U' will disable this limit.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dmaximum_7c_2da_ds_2dname_3amax"><strong>--maximum</strong>|<strong>-a</strong> <em>ds-name</em>:<em>max</em></a></strong><br />
-</dt>
+<dt><strong><a name="maximum_a_ds_name_max" class="item"><strong>--maximum</strong>|<strong>-a</strong> <em>ds-name</em>:<em>max</em></a></strong></dt>
+
<dd>
-alter the maximum value acceptable as input from the data source.
-Setting <em>max</em> to 'U' will disable this limit.
+<p>alter the maximum value acceptable as input from the data source.
+Setting <em>max</em> to 'U' will disable this limit.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2ddata_2dsource_2dtype_7c_2dd_ds_2dname_3adst"><strong>--data-source-type</strong>|<strong>-d</strong> <em>ds-name</em>:<em>DST</em></a></strong><br />
-</dt>
+<dt><strong><a name="data_source_type_d_ds_name_dst" class="item"><strong>--data-source-type</strong>|<strong>-d</strong> <em>ds-name</em>:<em>DST</em></a></strong></dt>
+
<dd>
-alter the type <strong>DST</strong> of a data source.
+<p>alter the type <strong>DST</strong> of a data source.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2ddata_2dsource_2drename_7c_2dr_old_2dname_3an"><strong>--data-source-rename</strong>|<strong>-r</strong> <em>old-name</em>:<em>new-name</em></a></strong><br />
-</dt>
+<dt><strong><a name="data_source_rename_r_old_name_new_name" class="item"><strong>--data-source-rename</strong>|<strong>-r</strong> <em>old-name</em>:<em>new-name</em></a></strong></dt>
+
<dd>
-rename a data source.
+<p>rename a data source.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong> <em>scale-value</em></a></strong><br />
-</dt>
+<dt><strong><a name="deltapos_scale_value" class="item"><strong>--deltapos</strong> <em>scale-value</em></a></strong></dt>
+
<dd>
-Alter the deviation scaling factor for the upper bound of the
+<p>Alter the deviation scaling factor for the upper bound of the
confidence band used internally to calculate violations for the
FAILURES <strong>RRA</strong>. 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 <strong>RRA</strong>.
+FAILURES <strong>RRA</strong>.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong> <em>scale-value</em></a></strong><br />
-</dt>
+<dt><strong><a name="deltaneg_scale_value" class="item"><strong>--deltaneg</strong> <em>scale-value</em></a></strong></dt>
+
<dd>
-Alter the deviation scaling factor for the lower bound of the confidence band
+<p>Alter the deviation scaling factor for the lower bound of the confidence band
used internally to calculate violations for the FAILURES <strong>RRA</strong>. The default
value is 2. As with <strong>--deltapos</strong>, this argument is unrelated to the scale
-factor chosen when graphing confidence bounds.
+factor chosen when graphing confidence bounds.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong> <em>failure-threshold</em></a></strong><br />
-</dt>
+<dt><strong><a name="failure_threshold_failure_threshold" class="item"><strong>--failure-threshold</strong> <em>failure-threshold</em></a></strong></dt>
+
<dd>
-Alter the number of confidence bound violations that constitute a failure for
+<p>Alter the number of confidence bound violations that constitute a failure for
purposes of the FAILURES <strong>RRA</strong>. This must be an integer less than or equal to
the window length of the FAILURES <strong>RRA</strong>. 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.
+simultaneously. Setting this option will reset the count of violations to 0.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong> <em>window-length</em></a></strong><br />
-</dt>
+<dt><strong><a name="window_length_window_length" class="item"><strong>--window-length</strong> <em>window-length</em></a></strong></dt>
+
<dd>
-Alter the number of time points in the temporal window for determining
+<p>Alter the number of time points in the temporal window for determining
failures. This must be an integer greater than or equal to the window
length of the FAILURES <strong>RRA</strong> and less than or equal to 28. Setting
-this option will reset the count of violations to 0.
+this option will reset the count of violations to 0.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong> <em>adaption-parameter</em></a></strong><br />
-</dt>
+<dt><strong><a name="alpha_adaption_parameter" class="item"><strong>--alpha</strong> <em>adaption-parameter</em></a></strong></dt>
+
<dd>
-Alter the intercept adaptation parameter for the Holt-Winters
-forecasting algorithm. This parameter must be between 0 and 1.
+<p>Alter the intercept adaptation parameter for the Holt-Winters
+forecasting algorithm. This parameter must be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong> <em>adaption-parameter</em></a></strong><br />
-</dt>
+<dt><strong><a name="beta_adaption_parameter" class="item"><strong>--beta</strong> <em>adaption-parameter</em></a></strong></dt>
+
<dd>
-Alter the slope adaptation parameter for the Holt-Winters forecasting
-algorithm. This parameter must be between 0 and 1.
+<p>Alter the slope adaptation parameter for the Holt-Winters forecasting
+algorithm. This parameter must be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong> <em>adaption-parameter</em></a></strong><br />
-</dt>
+<dt><strong><a name="gamma_adaption_parameter" class="item"><strong>--gamma</strong> <em>adaption-parameter</em></a></strong></dt>
+
<dd>
-Alter the seasonal coefficient adaptation parameter for the SEASONAL
-<strong>RRA</strong>. This parameter must be between 0 and 1.
+<p>Alter the seasonal coefficient adaptation parameter for the SEASONAL
+<strong>RRA</strong>. This parameter must be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong> <em>adaption-parameter</em></a></strong><br />
-</dt>
+<dt><strong><a name="gamma_deviation_adaption_parameter" class="item"><strong>--gamma-deviation</strong> <em>adaption-parameter</em></a></strong></dt>
+
<dd>
-Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
-<strong>RRA</strong>. This parameter must be between 0 and 1.
+<p>Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
+<strong>RRA</strong>. This parameter must be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dsmoothing_2dwindow_fraction_2dof_2dseason"><strong>--smoothing-window</strong> <em>fraction-of-season</em></a></strong><br />
-</dt>
+<dt><strong><a name="smoothing_window_fraction_of_season" class="item"><strong>--smoothing-window</strong> <em>fraction-of-season</em></a></strong></dt>
+
<dd>
-Alter the size of the smoothing window for the SEASONAL <strong>RRA</strong>. This must
-be between 0 and 1.
+<p>Alter the size of the smoothing window for the SEASONAL <strong>RRA</strong>. This must
+be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2dsmoothing_2dwindow_2ddeviation_fraction_2dof"><strong>--smoothing-window-deviation</strong> <em>fraction-of-season</em></a></strong><br />
-</dt>
+<dt><strong><a name="smoothing_window_deviation_fraction_of_season" class="item"><strong>--smoothing-window-deviation</strong> <em>fraction-of-season</em></a></strong></dt>
+
<dd>
-Alter the size of the smoothing window for the DEVSEASONAL <strong>RRA</strong>. This must
-be between 0 and 1.
+<p>Alter the size of the smoothing window for the DEVSEASONAL <strong>RRA</strong>. This must
+be between 0 and 1.</p>
</dd>
-<p></p>
-<dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong> <em>ds-name</em></a></strong><br />
-</dt>
+<dt><strong><a name="aberrant_reset_ds_name" class="item"><strong>--aberrant-reset</strong> <em>ds-name</em></a></strong></dt>
+
<dd>
-This option causes the aberrant behavior detection algorithm to reset
+<p>This option causes the aberrant behavior detection algorithm to reset
for the specified data source; that is, forget all it is has learnt so far.
Specifically, for the HWPREDICT or MHWPREDICT <strong>RRA</strong>, it sets the intercept and
slope coefficients to unknown. For the SEASONAL <strong>RRA</strong>, it sets all seasonal
(the values of the HWPREDICT or MHWPREDICT <strong>RRA</strong>), predicted deviations (the
values of the DEVPREDICT <strong>RRA</strong>), or failure history (the values of the
FAILURES <strong>RRA</strong>). This option will function even if not all the listed
-<strong>RRAs</strong> are present.
-</dd>
-<dd>
+<strong>RRAs</strong> are present.</p>
<p>Due to the implementation of this option, there is an indirect impact on
other data sources in the RRD. A smoothing algorithm is applied to
SEASONAL and DEVSEASONAL values on a periodic basis. During bootstrap
consequences, unless the data being collected for the non-reset data sources
is unusually volatile during the reinitialization period of the reset
data source.</p>
-</dd>
-<dd>
<p>Use of this tuning option is advised when the behavior of the data source
time series changes in a drastic and permanent manner.</p>
</dd>
-<p></p></dl>
+</dl>
<p>
</p>
<hr />