diff --git a/doc/rrdtune.html b/doc/rrdtune.html
index 59925ff366177cbd23ca507a497df5a0c03407b3..fe809e45ef4e011a1ed5fb41b310d7732a986c29 100644 (file)
--- a/doc/rrdtune.html
+++ b/doc/rrdtune.html
[<strong>--beta</strong> <em>adaption-parameter</em>]
[<strong>--gamma</strong> <em>adaption-parameter</em>]
[<strong>--gamma-deviation</strong> <em>adaption-parameter</em>]
+[<strong>--smoothing-window</strong> <em>fraction-of-season</em>]
+[<strong>--smoothing-window-deviation</strong> <em>fraction-of-season</em>]
[<strong>--aberrant-reset</strong> <em>ds-name</em>]</p>
<p>
</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>
+<dt><strong><a name="item_filename"><em>filename</em></a></strong></dt>
<dd>
<p>The name of the <strong>RRD</strong> you want to tune.</p>
</dd>
-</li>
-<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>
+<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></dt>
<dd>
<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>
-</li>
-<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>
+<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></dt>
<dd>
<p>alter the minimum value acceptable as input from the data source.
Setting <em>min</em> to 'U' will disable this limit.</p>
</dd>
-</li>
-<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>
+<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></dt>
<dd>
<p>alter the maximum value acceptable as input from the data source.
Setting <em>max</em> to 'U' will disable this limit.</p>
</dd>
-</li>
-<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>
+<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></dt>
<dd>
<p>alter the type <strong>DST</strong> of a data source.</p>
</dd>
-</li>
-<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>
+<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></dt>
<dd>
<p>rename a data source.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong> <em>scale-value</em></a></strong>
+<dt><strong><a name="item__2d_2ddeltapos_scale_2dvalue"><strong>--deltapos</strong> <em>scale-value</em></a></strong></dt>
<dd>
<p>Alter the deviation scaling factor for the upper bound of the
scale factor need not to agree with the value used internally by the
FAILURES <strong>RRA</strong>.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong> <em>scale-value</em></a></strong>
+<dt><strong><a name="item__2d_2ddeltaneg_scale_2dvalue"><strong>--deltaneg</strong> <em>scale-value</em></a></strong></dt>
<dd>
<p>Alter the deviation scaling factor for the lower bound of the confidence band
@@ -123,8 +118,7 @@ used internally to calculate violations for the FAILURES <strong>RRA</strong>. T
value is 2. As with <strong>--deltapos</strong>, this argument is unrelated to the scale
factor chosen when graphing confidence bounds.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong> <em>failure-threshold</em></a></strong>
+<dt><strong><a name="item__2d_2dfailure_2dthreshold_failure_2dthreshold"><strong>--failure-threshold</strong> <em>failure-threshold</em></a></strong></dt>
<dd>
<p>Alter the number of confidence bound violations that constitute a failure for
the tune option, so one can reset failure-threshold and window-length
simultaneously. Setting this option will reset the count of violations to 0.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong> <em>window-length</em></a></strong>
+<dt><strong><a name="item__2d_2dwindow_2dlength_window_2dlength"><strong>--window-length</strong> <em>window-length</em></a></strong></dt>
<dd>
<p>Alter the number of time points in the temporal window for determining
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.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong> <em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dalpha_adaption_2dparameter"><strong>--alpha</strong> <em>adaption-parameter</em></a></strong></dt>
<dd>
<p>Alter the intercept adaptation parameter for the Holt-Winters
forecasting algorithm. This parameter must be between 0 and 1.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong> <em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dbeta_adaption_2dparameter"><strong>--beta</strong> <em>adaption-parameter</em></a></strong></dt>
<dd>
<p>Alter the slope adaptation parameter for the Holt-Winters forecasting
algorithm. This parameter must be between 0 and 1.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong> <em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dgamma_adaption_2dparameter"><strong>--gamma</strong> <em>adaption-parameter</em></a></strong></dt>
<dd>
<p>Alter the seasonal coefficient adaptation parameter for the SEASONAL
<strong>RRA</strong>. This parameter must be between 0 and 1.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong> <em>adaption-parameter</em></a></strong>
+<dt><strong><a name="item__2d_2dgamma_2ddeviation_adaption_2dparameter"><strong>--gamma-deviation</strong> <em>adaption-parameter</em></a></strong></dt>
<dd>
<p>Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
<strong>RRA</strong>. This parameter must be between 0 and 1.</p>
</dd>
-</li>
-<dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong> <em>ds-name</em></a></strong>
+<dt><strong><a name="item__2d_2dsmoothing_2dwindow_fraction_2dof_2dseason"><strong>--smoothing-window</strong> <em>fraction-of-season</em></a></strong></dt>
+
+<dd>
+<p>Alter the size of the smoothing window for the SEASONAL <strong>RRA</strong>. This must
+be between 0 and 1.</p>
+</dd>
+<dt><strong><a name="item__2d_2dsmoothing_2dwindow_2ddeviation_fraction_2dof"><strong>--smoothing-window-deviation</strong> <em>fraction-of-season</em></a></strong></dt>
+
+<dd>
+<p>Alter the size of the smoothing window for the DEVSEASONAL <strong>RRA</strong>. This must
+be between 0 and 1.</p>
+</dd>
+<dt><strong><a name="item__2d_2daberrant_2dreset_ds_2dname"><strong>--aberrant-reset</strong> <em>ds-name</em></a></strong></dt>
<dd>
<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 <strong>RRA</strong>, it sets the intercept and slope
-coefficients to unknown. For the SEASONAL <strong>RRA</strong>, it sets all seasonal
+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
coefficients to unknown. For the DEVSEASONAL <strong>RRA</strong>, it sets all seasonal
-deviation coefficients to unknown. For the FAILURES <strong>RRA</strong>, it erases
-the violation history. Note that reset does not erase past predictions
-(the values of the HWPREDICT <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.</p>
-</dd>
-<dd>
+deviation coefficients to unknown. For the FAILURES <strong>RRA</strong>, it erases the
+violation history. Note that reset does not erase past predictions
+(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.</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>
-</li>
</dl>
<p>
</p>