1RRDTUNE(1) rrdtool RRDTUNE(1)
2
6 rrdtune - Modify some basic properties of a Round Robin Database
7
9 rrdtool tune filename [--heartbeat|-h ds-name:heartbeat] [--mini‐
10 mum|-i ds-name:min] [--maximum|-a ds-name:max]
11 [--data-source-type|-d ds-name:DST] [--data-source-rename|-r old-
12 name:new-name] [--deltapos scale-value] [--deltaneg scale-value]
13 [--failure-threshold failure-threshold] [--window-length window-length]
14 [--alpha adaption-parameter] [--beta adaption-parameter] [--gamma adap‐
15 tion-parameter] [--gamma-deviation adaption-parameter] [--aber‐
16 rant-reset ds-name]
17
19 The tune option allows you to alter some of the basic configuration
20 values stored in the header area of a Round Robin Database (RRD).
21 One application of the tune function is to relax the validation rules
23 on an RRD. This allows to fill a new RRD with data available in larger
24 intervals than what you would normally want to permit. Be very careful
25 with tune operations for COMPUTE data sources. Setting the min, max,
26 and heartbeat for a COMPUTE data source without changing the data
27 source type to a non-COMPUTE DST WILL corrupt the data source header in
28 the RRD.
29 A second application of the tune function is to set or alter parameters
31 used by the specialized function RRAs for aberrant behavior detection.
32 filename
34 The name of the RRD you want to tune.
35 --heartbeat|-h ds-name:heartbeat
37 modify the heartbeat of a data source. By setting this to a
38 high value the RRD will accept things like one value per day.
39 --minimum|-i ds-name:min
41 alter the minimum value acceptable as input from the data
42 source. Setting min to 'U' will disable this limit.
43 --maximum|-a ds-name:max
45 alter the maximum value acceptable as input from the data
46 source. Setting max to 'U' will disable this limit.
47 --data-source-type|-d ds-name:DST
49 alter the type DST of a data source.
50 --data-source-rename|-r old-name:new-name
52 rename a data source.
53 --deltapos scale-value
55 Alter the deviation scaling factor for the upper bound of the
56 confidence band used internally to calculate violations for the
57 FAILURES RRA. The default value is 2. Note that this parameter
58 is not related to graphing confidence bounds which must be
59 specified as a CDEF argument to generate a graph with confi‐
60 dence bounds. The graph scale factor need not to agree with the
61 value used internally by the FAILURES RRA.
62 --deltaneg scale-value
64 Alter the deviation scaling factor for the lower bound of the
65 confidence band used internally to calculate violations for the
66 FAILURES RRA. The default value is 2. As with --deltapos, this
67 argument is unrelated to the scale factor chosen when graphing
68 confidence bounds.
69 --failure-threshold failure-threshold
71 Alter the number of confidence bound violations that constitute
72 a failure for purposes of the FAILURES RRA. This must be an
73 integer less than or equal to the window length of the FAILURES
74 RRA. This restriction is not verified by the tune option, so
75 one can reset failure-threshold and window-length simultane‐
76 ously. Setting this option will reset the count of violations
77 to 0.
78 --window-length window-length
80 Alter the number of time points in the temporal window for
81 determining failures. This must be an integer greater than or
82 equal to the window length of the FAILURES RRA and less than or
83 equal to 28. Setting this option will reset the count of viola‐
84 tions to 0.
85 --alpha adaption-parameter
87 Alter the intercept adaptation parameter for the Holt-Winters
88 forecasting algorithm. This parameter must be between 0 and 1.
89 --beta adaption-parameter
91 Alter the slope adaptation parameter for the Holt-Winters fore‐
92 casting algorithm. This parameter must be between 0 and 1.
93 --gamma adaption-parameter
95 Alter the seasonal coefficient adaptation parameter for the
96 SEASONAL RRA. This parameter must be between 0 and 1.
97 --gamma-deviation adaption-parameter
99 Alter the seasonal deviation adaptation parameter for the
100 DEVSEASONAL RRA. This parameter must be between 0 and 1.
101 --aberrant-reset ds-name
103 This option causes the aberrant behavior detection algorithm to
104 reset for the specified data source; that is, forget all it is
105 has learnt so far. Specifically, for the HWPREDICT RRA, it
106 sets the intercept and slope coefficients to unknown. For the
107 SEASONAL RRA, it sets all seasonal coefficients to unknown. For
108 the DEVSEASONAL RRA, it sets all seasonal deviation coeffi‐
109 cients to unknown. For the FAILURES RRA, it erases the viola‐
110 tion history. Note that reset does not erase past predictions
111 (the values of the HWPREDICT RRA), predicted deviations (the
112 values of the DEVPREDICT RRA), or failure history (the values
113 of the FAILURES RRA). This option will function even if not
114 all the listed RRAs are present.
115 Due to the implementation of this option, there is an indirect
117 impact on other data sources in the RRD. A smoothing algorithm
118 is applied to SEASONAL and DEVSEASONAL values on a periodic
119 basis. During bootstrap initialization this smoothing is
120 deferred. For efficiency, the implementation of smoothing is
121 not data source specific. This means that utilizing reset for
122 one data source will delay running the smoothing algorithm for
123 all data sources in the file. This is unlikely to have serious
124 consequences, unless the data being collected for the non-reset
125 data sources is unusually volatile during the reinitialization
126 period of the reset data source.
127 Use of this tuning option is advised when the behavior of the
129 data source time series changes in a drastic and permanent man‐
130 ner.
131
133 "rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000"
134 Set the minimum required heartbeat for data sources 'in', 'out' and
136 'through' to 10'000 seconds which is a little over one day in data.rrd.
137 This would allow to feed old data from MRTG-2.0 right into RRDtool
138 without generating *UNKNOWN* entries.
139
141 "rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3"
142 If the FAILURES RRA is implicitly created, the default window-length is
144 9 and the default failure-threshold is 7. This command now defines a
145 failure as 3 or more violations in a temporal window of 5 time points.
146
148 Tobias Oetiker <tobi@oetiker.ch>
1491.2.27 2008-02-17 RRDTUNE(1)