X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Frrdtune.html;fp=doc%2Frrdtune.html;h=6c289dfd730f1327c2e871c68696cad6cdfd68ef;hb=3741f89bbcc7e8c9dbab7d76bbd2fe28249cfded;hp=59925ff366177cbd23ca507a497df5a0c03407b3;hpb=5ae9312d35bd9931a761a15cbf1e8effe2e7b5d4;p=pkg-rrdtool.git diff --git a/doc/rrdtune.html b/doc/rrdtune.html index 59925ff..6c289df 100644 --- a/doc/rrdtune.html +++ b/doc/rrdtune.html @@ -64,46 +64,40 @@ the data source header in the RRD.

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

-
filename +
filename

The name of the RRD you want to tune.

- -
--heartbeat|-h ds-name:heartbeat +
--heartbeat|-h ds-name:heartbeat

modify the heartbeat of a data source. By setting this to a high value the RRD will accept things like one value per day.

- -
--minimum|-i ds-name:min +
--minimum|-i ds-name:min

alter the minimum value acceptable as input from the data source. Setting min to 'U' will disable this limit.

- -
--maximum|-a ds-name:max +
--maximum|-a ds-name:max

alter the maximum value acceptable as input from the data source. Setting max to 'U' will disable this limit.

- -
--data-source-type|-d ds-name:DST +
--data-source-type|-d ds-name:DST

alter the type DST of a data source.

- -
--data-source-rename|-r old-name:new-name +
--data-source-rename|-r old-name:new-name

rename a data source.

- -
--deltapos scale-value +
--deltapos scale-value

Alter the deviation scaling factor for the upper bound of the @@ -114,8 +108,7 @@ 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 RRA.

- -
--deltaneg scale-value +
--deltaneg scale-value

Alter the deviation scaling factor for the lower bound of the confidence band @@ -123,8 +116,7 @@ used internally to calculate violations for the FAILURES RRA. T value is 2. As with --deltapos, this argument is unrelated to the scale factor chosen when graphing confidence bounds.

- -
--failure-threshold failure-threshold +
--failure-threshold failure-threshold

Alter the number of confidence bound violations that constitute a failure for @@ -133,8 +125,7 @@ the window length of the FAILURES RRA. This restriction is not the tune option, so one can reset failure-threshold and window-length simultaneously. Setting this option will reset the count of violations to 0.

- -
--window-length window-length +
--window-length window-length

Alter the number of time points in the temporal window for determining @@ -142,36 +133,31 @@ failures. This must be an integer greater than or equal to the window length of the FAILURES RRA and less than or equal to 28. Setting this option will reset the count of violations to 0.

- -
--alpha adaption-parameter +
--alpha adaption-parameter

Alter the intercept adaptation parameter for the Holt-Winters forecasting algorithm. This parameter must be between 0 and 1.

- -
--beta adaption-parameter +
--beta adaption-parameter

Alter the slope adaptation parameter for the Holt-Winters forecasting algorithm. This parameter must be between 0 and 1.

- -
--gamma adaption-parameter +
--gamma adaption-parameter

Alter the seasonal coefficient adaptation parameter for the SEASONAL RRA. This parameter must be between 0 and 1.

- -
--gamma-deviation adaption-parameter +
--gamma-deviation adaption-parameter

Alter the seasonal deviation adaptation parameter for the DEVSEASONAL RRA. This parameter must be between 0 and 1.

- -
--aberrant-reset ds-name +
--aberrant-reset ds-name

This option causes the aberrant behavior detection algorithm to reset @@ -184,8 +170,6 @@ the violation history. Note that reset does not erase past predictions (the values of the HWPREDICT RRA), predicted deviations (the values of the DEVPREDICT RRA), or failure history (the values of the FAILURES RRA). This option will function even if not all the listed 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 @@ -196,12 +180,9 @@ 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.

-