1RRDTUNE(1)                          rrdtool                         RRDTUNE(1)
2
3
4

NAME

6       rrdtune - Modify some basic properties of a Round Robin Database
7

SYNOPSIS

9       rrdtool tune filename [--heartbeat|-h ds-name:heartbeat]
10       [--minimum|-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|-p scale-value] [--deltaneg|-n scale-value]
13       [--failure-threshold|-f failure-threshold] [--window-length|-w window-
14       length] [--alpha|-x adaption-parameter] [--beta|-y adaption-parameter]
15       [--gamma|-z adaption-parameter] [--gamma-deviation|-v adaption-
16       parameter] [--smoothing-window|-s fraction-of-season]
17       [--smoothing-window-deviation|-S fraction-of-season]
18       [--aberrant-reset|-b ds-name] [--step|-t newstep] [--daemon|-D address]
19       [DEL:ds-name] [DS:ds-spec] [DELRRA:index] [RRA:rra-spec]
20       [RRA#index:[+-=]<number]>
21

DESCRIPTION

23       The tune option allows you to alter some of the basic configuration
24       values stored in the header area of a Round Robin Database (RRD).
25
26       One application of the tune function is to relax the validation rules
27       on an RRD. This allows you to fill a new RRD with data available in
28       larger intervals than what you would normally want to permit. Be very
29       careful with tune operations for COMPUTE data sources.  Setting the
30       min, max, and  heartbeat for a COMPUTE data source without changing the
31       data source type to a non-COMPUTE DST WILL corrupt the data source
32       header in the RRD.
33
34       A second application of the tune function is to set or alter parameters
35       used by the specialized function RRAs for aberrant behavior detection.
36
37       Still another application is to add or remove data sources (DS) or add
38       / remove or alter some aspects of round-robin archives (RRA). These
39       operations are not really done in-place, but rather generate a new RRD
40       file internally and move it over the original file. Data is kept intact
41       during theses operations.  For even more in-depth modifications you may
42       review the --source and --template options of the create function which
43       allow you to combine multiple RRD files into a new one and which is
44       even more clever in what data it is able to keep or "regenerate".
45
46       filename
47               The name of the RRD you want to tune.
48
49       --heartbeat|-h ds-name:heartbeat
50               modify the heartbeat of a data source. By setting this to a
51               high value the RRD will accept things like one value per day.
52
53       --minimum|-i ds-name:min
54               alter the minimum value acceptable as input from the data
55               source.  Setting min to 'U' will disable this limit.
56
57       --maximum|-a ds-name:max
58               alter the maximum value acceptable as input from the data
59               source.  Setting max to 'U' will disable this limit.
60
61       --data-source-type|-d ds-name:DST
62               alter the type DST of a data source.
63
64       --data-source-rename|-r old-name:new-name
65               rename a data source.
66
67       --deltapos|-p scale-value
68               Alter the deviation scaling factor for the upper bound of the
69               confidence band used internally to calculate violations for the
70               FAILURES RRA. The default value is 2. Note that this parameter
71               is not related to graphing confidence bounds which must be
72               specified as a CDEF argument to generate a graph with
73               confidence bounds. The graph scale factor need not to agree
74               with the value used internally by the FAILURES RRA.
75
76       --deltaneg|-n scale-value
77               Alter the deviation scaling factor for the lower bound of the
78               confidence band used internally to calculate violations for the
79               FAILURES RRA. The default value is 2. As with --deltapos, this
80               argument is unrelated to the scale factor chosen when graphing
81               confidence bounds.
82
83       --failure-threshold|-f failure-threshold
84               Alter the number of confidence bound violations that constitute
85               a failure for purposes of the FAILURES RRA. This must be an
86               integer less than or equal to the window length of the FAILURES
87               RRA. This restriction is not verified by the tune option, so
88               one can reset failure-threshold and window-length
89               simultaneously. Setting this option will reset the count of
90               violations to 0.
91
92       --window-length|-w window-length
93               Alter the number of time points in the temporal window for
94               determining failures. This must be an integer greater than or
95               equal to the window length of the FAILURES RRA and less than or
96               equal to 28. Setting this option will reset the count of
97               violations to 0.
98
99       --alpha|-x adaption-parameter
100               Alter the intercept adaptation parameter for the Holt-Winters
101               forecasting algorithm. This parameter must be between 0 and 1.
102
103       --beta|-y adaption-parameter
104               Alter the slope adaptation parameter for the Holt-Winters
105               forecasting algorithm. This parameter must be between 0 and 1.
106
107       --gamma|-z adaption-parameter
108               Alter the seasonal coefficient adaptation parameter for the
109               SEASONAL RRA. This parameter must be between 0 and 1.
110
111       --gamma-deviation|-v adaption-parameter
112               Alter the seasonal deviation adaptation parameter for the
113               DEVSEASONAL RRA. This parameter must be between 0 and 1.
114
115       --smoothing-window|-s fraction-of-season
116               Alter the size of the smoothing window for the SEASONAL RRA.
117               This must be between 0 and 1.
118
119       --smoothing-window-deviation|-S fraction-of-season
120               Alter the size of the smoothing window for the DEVSEASONAL RRA.
121               This must be between 0 and 1.
122
123       --aberrant-reset|-b ds-name
124               This option causes the aberrant behavior detection algorithm to
125               reset for the specified data source; that is, forget all it is
126               has learnt so far.  Specifically, for the HWPREDICT or
127               MHWPREDICT RRA, it sets the intercept and slope coefficients to
128               unknown. For the SEASONAL RRA, it sets all seasonal
129               coefficients to unknown. For the DEVSEASONAL RRA, it sets all
130               seasonal deviation coefficients to unknown. For the FAILURES
131               RRA, it erases the violation history. Note that reset does not
132               erase past predictions (the values of the HWPREDICT or
133               MHWPREDICT RRA), predicted deviations (the values of the
134               DEVPREDICT RRA), or failure history (the values of the FAILURES
135               RRA).  This option will function even if not all the listed
136               RRAs are present.
137
138               Due to the implementation of this option, there is an indirect
139               impact on other data sources in the RRD. A smoothing algorithm
140               is applied to SEASONAL and DEVSEASONAL values on a periodic
141               basis. During bootstrap initialization this smoothing is
142               deferred. For efficiency, the implementation of smoothing is
143               not data source specific. This means that utilizing reset for
144               one data source will delay running the smoothing algorithm for
145               all data sources in the file. This is unlikely to have serious
146               consequences, unless the data being collected for the non-reset
147               data sources is unusually volatile during the reinitialization
148               period of the reset data source.
149
150               Use of this tuning option is advised when the behavior of the
151               data source time series changes in a drastic and permanent
152               manner.
153
154       --step|-t newstep
155               Changes the step size of the RRD to newstep.
156
157               TODO: add proper documentation
158
159       --daemon|-D address
160               NOTE: Because the -d (small letter 'd') option was already
161               taken, this function (unlike most other) uses the capital
162               letter 'D' for the one-letter option to name the cache daemon.
163
164               If given, RRDTool will try to connect to the caching daemon
165               rrdcached at address and will fail if the connection cannot be
166               established. If the connection is successfully established the
167               data for the filename will be flushed before performing the
168               copy/modify operation. Afterwards the filename will be
169               forgotten by the cache daemon, so that the next access using
170               the caching daemon will read the proper structure.
171
172               This sequence of operations is designed to achieve a consistent
173               overall result with respect to RRD internal file consistency
174               when using one of the DS or RRA changing operations (that is:
175               the resulting file should always be a valid RRD file,
176               regardless of concurrent updates through the caching daemon).
177               Regarding data consistency such guarantees are not made:
178               Without external synchronization concurrent updates may be
179               lost.
180
181               For a list of accepted formats, see the -l option in the
182               rrdcached manual.
183
184       DEL:ds-name
185               Every data source named with a DEL specification will be
186               removed.  The resulting RRD will miss both the definition and
187               the data for that data source. Multiple DEL specifications are
188               permitted.
189
190       DS:ds-spec
191               For every such data source definition (for the exact syntax see
192               the create command), a new data source will be added to the
193               RRD. Multiple DS specifications are permitted.
194
195       DELRRA:index
196               Removes the RRA with index index. The index is zero-based, that
197               is the very first RRA has index 0.
198
199       RRA:rra-spec
200               For every such archive definition (for the exact syntax see the
201               create command), a new RRA will be added to the output RRD.
202               Multiple RRA specifications are permitted.
203
204       RRA#index:[+-=]<number>
205               Adds/removes or sets the given number of rows for the RRA with
206               index <index>. The index is zero-based, that is the very first
207               RRA has index 0.
208

EXAMPLE 1

210       "rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000"
211
212       Set the minimum required heartbeat for data sources 'in', 'out' and
213       'through' to 100'000 seconds which is a little over one day in
214       data.rrd.  This would allow to feed old data from MRTG-2.0 right into
215       RRDtool without generating *UNKNOWN* entries.
216

EXAMPLE 2

218       "rrdtool tune monitor.rrd --window-length 5 --failure-threshold 3"
219
220       If the FAILURES RRA is implicitly created, the default window-length is
221       9 and the default failure-threshold is 7. This command now defines a
222       failure as 3 or more violations in a temporal window of 5 time points.
223

EXAMPLE 3

225       "rrdtool tune some.rrd DEL:a RRA#0:+10"
226
227       Delete the data source named a and extend the very first archive by 10
228       rows.  This will in fact replace the input RRD with a new RRD keeping
229       all existing data.  For most practical use cases this is identical to a
230       real in-place modification.
231

AUTHORS

233       Tobias Oetiker <tobi@oetiker.ch>, Peter Stamfest <peter@stamfest.at>
234
235
236
2371.5.999                           2016-11-03                        RRDTUNE(1)
Impressum