X-Git-Url: https://git.tokkee.org/?p=pkg-rrdtool.git;a=blobdiff_plain;f=doc%2Frrdtune.html;h=feeba0d7fa11411c8ea2e6be772660abbc6848d1;hp=ea6baad9ae45e3acbe86af32e873e6caa1f792ec;hb=645054bac6187b0e83fd4125fd59e4feda216b64;hpb=ffa00ac697dccce18dca8880ca7a14066521ac5c diff --git a/doc/rrdtune.html b/doc/rrdtune.html index ea6baad..feeba0d 100644 --- a/doc/rrdtune.html +++ b/doc/rrdtune.html @@ -1,14 +1,18 @@ + rrdtune + -

+ +
+

+ + +

@@ -64,131 +72,115 @@ 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. +

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. +

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. +

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. +

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. +

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. +

rename a data source.

-

-
--deltapos scale-value
-
+
--deltapos scale-value
+
-Alter the deviation scaling factor for the upper bound of the +

Alter the deviation scaling factor for the upper bound of the confidence band used internally to calculate violations for the FAILURES RRA. 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 RRA. +FAILURES RRA.

-

-
--deltaneg scale-value
-
+
--deltaneg scale-value
+
-Alter the deviation scaling factor for the lower bound of the confidence band +

Alter the deviation scaling factor for the lower bound of the confidence band used internally to calculate violations for the FAILURES RRA. The default value is 2. As with --deltapos, this argument is unrelated to the scale -factor chosen when graphing confidence bounds. +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 +

Alter the number of confidence bound violations that constitute a failure for purposes of the FAILURES RRA. This must be an integer less than or equal to the window length of the FAILURES RRA. 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.

-

-
--window-length window-length
-
+
--window-length window-length
+
-Alter the number of time points in the temporal window for determining +

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 RRA 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.

-

-
--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. +

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. +

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. +

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. +

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

-

-
--smoothing-window fraction-of-season
-
+
--smoothing-window fraction-of-season
+
-Alter the size of the smoothing window for the SEASONAL RRA. This must -be between 0 and 1. +

Alter the size of the smoothing window for the SEASONAL RRA. This must +be between 0 and 1.

-

-
--smoothing-window-deviation fraction-of-season
-
+
--smoothing-window-deviation fraction-of-season
+
-Alter the size of the smoothing window for the DEVSEASONAL RRA. This must -be between 0 and 1. +

Alter the size of the smoothing window for the DEVSEASONAL RRA. This must +be between 0 and 1.

-

-
--aberrant-reset ds-name
-
+
--aberrant-reset ds-name
+
-This option causes the aberrant behavior detection algorithm to reset +

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 RRA, it sets the intercept and slope coefficients to unknown. For the SEASONAL RRA, it sets all seasonal @@ -198,9 +190,7 @@ violation history. Note that reset does not erase past predictions (the values of the HWPREDICT or MHWPREDICT 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. -

-
+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 @@ -211,12 +201,10 @@ 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.

-

+