fixed many pod bugs while creating the new website

[rrdtool.git] / doc / rrdtune.pod

diff --git a/doc/rrdtune.pod b/doc/rrdtune.pod
index f96d8d1..3e96f6d 100644 (file)
--- a/doc/rrdtune.pod
+++ b/doc/rrdtune.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
 =head1 NAME
 

-rrdtool tune - Modify some basic properties of a Round Robin Database
+rrdtune - Modify some basic properties of a Round Robin Database

 
 =for html <div align="right"><a href="rrdtune.pdf">PDF</a> version.</div>
 
 
 =for html <div align="right"><a href="rrdtune.pdf">PDF</a> version.</div>
 


@@ -13,25 +13,27 @@ S<[B<--maximum>|B<-a> I<ds-name>:I<max>]>
 S<[B<--data-source-type>|B<-d> I<ds-name>:I<DST>]>
 S<[B<--data-source-rename>|B<-r> I<old-name>:I<new-name>]>
 S<[B<--deltapos> I<scale-value>]>
 S<[B<--data-source-type>|B<-d> I<ds-name>:I<DST>]>
 S<[B<--data-source-rename>|B<-r> I<old-name>:I<new-name>]>
 S<[B<--deltapos> I<scale-value>]>

-S<[B<--deltaneg> I<scale value>]>
+S<[B<--deltaneg> I<scale-value>]>

 S<[B<--failure-threshold> I<failure-threshold>]>
 S<[B<--window-length> I<window-length>]>
 S<[B<--alpha> I<adaption-parameter>]>
 S<[B<--beta> I<adaption-parameter>]>
 S<[B<--gamma> I<adaption-parameter>]>
 S<[B<--failure-threshold> I<failure-threshold>]>
 S<[B<--window-length> I<window-length>]>
 S<[B<--alpha> I<adaption-parameter>]>
 S<[B<--beta> I<adaption-parameter>]>
 S<[B<--gamma> I<adaption-parameter>]>

+S<[B<--gamma-deviation> I<adaption-parameter>]>
+S<[B<--aberrant-reset> I<ds-name>]>

 
 =head1 DESCRIPTION
 
 The tune option allows you to alter some of the basic configuration
 values stored in the header area of a Round Robin Database (B<RRD>).
 
 =head1 DESCRIPTION
 
 The tune option allows you to alter some of the basic configuration
 values stored in the header area of a Round Robin Database (B<RRD>).

-All these tunable parameters together decide when data fed into an 
-B<RRD> is to be regarded as invalid. Invalid data is entered into the 
-database as *UNKNOWN*.

 
 One application of the B<tune> function is to relax the 
 validation rules on an B<RRD>. This allows to fill a new B<RRD> with
 data available in larger intervals than what you would normally want
 
 One application of the B<tune> function is to relax the 
 validation rules on an B<RRD>. This allows to fill a new B<RRD> with
 data available in larger intervals than what you would normally want

-to permit.
+to permit. Be very careful with tune operations for COMPUTE data sources.
+Setting the I<min>, I<max>, and  I<heartbeat> for a COMPUTE data source
+without changing the data source type to a non-COMPUTE B<DST> WILL corrupt
+the data source header in the B<RRD>.

 
 A second application of the B<tune> function is to set or alter parameters
 used by the specialized function B<RRAs> for aberrant behavior detection.
 
 A second application of the B<tune> function is to set or alter parameters
 used by the specialized function B<RRAs> for aberrant behavior detection.


@@ -45,7 +47,7 @@ The name of the B<RRD> you want to tune.
 =item S<B<--heartbeat>|B<-h> I<ds-name>:I<heartbeat>>
 
 modify the I<heartbeat> of a data source. By setting this to a high
 =item S<B<--heartbeat>|B<-h> I<ds-name>:I<heartbeat>>
 
 modify the I<heartbeat> of a data source. By setting this to a high

-value the rrd will accept things like one value per day ...
+value the RRD will accept things like one value per day ...

 
 =item S<B<--minimum>|B<-i> I<ds-name>:I<min>>
 
 
 =item S<B<--minimum>|B<-i> I<ds-name>:I<min>>
 


@@ -70,9 +72,9 @@ rename a data source
 Alter the deviation scaling factor for the upper bound of the confidence band
 used internally to calculate violations for the FAILURES B<RRA>. The default
 value is 2. Note that this parameter is not related to graphing confidence
 Alter the deviation scaling factor for the upper bound of the confidence band
 used internally to calculate violations for the FAILURES B<RRA>. The default
 value is 2. Note that this parameter is not related to graphing confidence

-bounds, that scale factor is specified as a CDEV argument to generate a graph with
-confidence bounds. It need agree with the value used internally by the FAILURES
-B<RRA> (although common sense dictates it should).
+bounds, that scale factor must be specified as a CDEF argument to generate 
+a graph with confidence bounds. The graph scale factor need not agree with the 
+value used internally by the FAILURES B<RRA>.

 
 =item S<B<--deltaneg> I<scale-value>>
 
 
 =item S<B<--deltaneg> I<scale-value>>
 


@@ -103,13 +105,45 @@ Must be between 0 and 1.
 
 =item S<B<--beta> I<adaption-parameter>>
 
 
 =item S<B<--beta> I<adaption-parameter>>
 

-Alter the intercept adaptation parameter for the Holt-Winters forecasting algorithm.
+Alter the slope adaptation parameter for the Holt-Winters forecasting algorithm.

 Must be between 0 and 1.
 
 =item S<B<--gamma> I<adaption-parameter>>
 
 Must be between 0 and 1.
 
 =item S<B<--gamma> I<adaption-parameter>>
 

-Alter the seasonal coefficient and deviation adaptation parameters the SEASONAL and
-DEVSEAONAL B<RRAs>. Must be between 0 and 1.
+Alter the seasonal coefficient adaptation parameter for the SEASONAL
+B<RRA>. Must be between 0 and 1.
+
+=item S<B<--gamma-deviation> I<adaption-parameter>>
+
+Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
+B<RRA>. Must be between 0 and 1.
+
+=item S<B<--aberrant-reset> I<ds-name>>
+
+This option causes the aberrant behavior detection algorithm to reset
+for the specified data source; that is, forget all it is has learn.
+Specifically, for the HWPREDICT B<RRA>, it sets the intercept and slope
+coefficients to unknown. For the SEASONAL B<RRA>, it sets all seasonal
+coefficients to unknown. For the DEVSEASONAL B<RRA>, it sets all seasonal
+deviation coefficients to unknown. For the FAILURES B<RRA>, it erases
+the violation history. Note that reset does not erase past predictions
+(the values of the HWPREDICT B<RRA>), predicted deviations (the values of the
+DEVPREDICT B<RRA>), or failure history (the values of the FAILURES B<RRA>).
+This option will function even if not all the listed B<RRAs> are present.
+
+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
+initialization this smoothing is deferred. For efficiency, the implementation
+of smoothing is not data source specific. This means that utilizing
+reset for one data source will delay running the smoothing algorithm
+for all data sources in the file. This is unlikely to have serious
+consequences, unless the data being collected for the non-reset data sources 
+is unusually volatile during the reinitialization period of the reset 
+data source.
+
+Use of this tuning option is advised when the behavior of the data source 
+time series changes in a drastic and permanent manner.

 
 =back
 
 
 =back
 


@@ -119,15 +153,15 @@ C<rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000>
 
 Set the minimum required heartbeat for data sources 'in', 'out' 
 and 'through' to 10000 seconds which is a little over one day in data.rrd.
 
 Set the minimum required heartbeat for data sources 'in', 'out' 
 and 'through' to 10000 seconds which is a little over one day in data.rrd.

-This would allow to feed old data from mrtg-2.0 right into
-rrdtool without generating *UNKNOWN* entries.
+This would allow to feed old data from MRTG-2.0 right into
+RRDtool without generating *UNKNOWN* entries.

 
 =head1 EXAMPLE 2
 
 C<rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3>
 
 If the FAILURES B<RRA> is implicitly created, the default window-length is 9 and 
 
 =head1 EXAMPLE 2
 
 C<rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3>
 
 If the FAILURES B<RRA> is implicitly created, the default window-length is 9 and 

-the default failure-thresold is 7. This command now defines a failure as 3 or more
+the default failure-threshold is 7. This command now defines a failure as 3 or more

 violations in a temporal window of 5 time points.
 
 =head1 AUTHOR
 violations in a temporal window of 5 time points.
 
 =head1 AUTHOR