.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RRDTUNE 1"
.TH RRDTUNE 1 2024-03-17 1.7.2 rrdtool
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
rrdtune \- Modify some basic properties of a Round Robin Database
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBrrdtool\fR \fBtune\fR \fIfilename\fR
[\fB\-\-heartbeat\fR|\fB\-h\fR\ \fIds-name\fR:\fIheartbeat\fR]
[\fB\-\-minimum\fR|\fB\-i\fR\ \fIds-name\fR:\fImin\fR]
[\fB\-\-maximum\fR|\fB\-a\fR\ \fIds-name\fR:\fImax\fR]
[\fB\-\-data\-source\-type\fR|\fB\-d\fR\ \fIds-name\fR:\fIDST\fR]
[\fB\-\-data\-source\-rename\fR|\fB\-r\fR\ \fIold-name\fR:\fInew-name\fR]
[\fB\-\-deltapos\fR|\fB\-p\fR\ \fIscale-value\fR]
[\fB\-\-deltaneg\fR|\fB\-n\fR\ \fIscale-value\fR]
[\fB\-\-failure\-threshold\fR|\fB\-f\fR\ \fIfailure-threshold\fR]
[\fB\-\-window\-length\fR|\fB\-w\fR\ \fIwindow-length\fR]
[\fB\-\-alpha\fR|\fB\-x\fR\ \fIadaption-parameter\fR]
[\fB\-\-beta\fR|\fB\-y\fR\ \fIadaption-parameter\fR]
[\fB\-\-gamma\fR|\fB\-z\fR\ \fIadaption-parameter\fR]
[\fB\-\-gamma\-deviation\fR|\fB\-v\fR\ \fIadaption-parameter\fR]
[\fB\-\-smoothing\-window\fR|\fB\-s\fR\ \fIfraction-of-season\fR]
[\fB\-\-smoothing\-window\-deviation\fR|\fB\-S\fR\ \fIfraction-of-season\fR]
[\fB\-\-aberrant\-reset\fR|\fB\-b\fR\ \fIds-name\fR]
[\fB\-\-step\fR|\fB\-t\fR\ \fInewstep\fR]
[\fB\-\-daemon\fR|\fB\-D\fR\ \fIaddress\fR]
[\fBDEL:\fR\fIds-name\fR]
[\fBDS:\fR\fIds-spec\fR]
[\fBDELRRA:\fR\fIindex\fR]
[\fBRRA:\fR\fIrra-spec\fR]
[\fBRRA#\fR\fIindex\fR:[+\-=]<number]>
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The tune option allows you to alter some of the basic configuration
values stored in the header area of a Round Robin Database (\fBRRD\fR).
.PP
One application of the \fBtune\fR function is to relax the
validation rules on an \fBRRD\fR. This allows you to fill a new \fBRRD\fR with
data available in larger intervals than what you would normally want
to permit. Be very careful with tune operations for COMPUTE data sources.
Setting the \fImin\fR, \fImax\fR, and  \fIheartbeat\fR for a COMPUTE data source
without changing the data source type to a non-COMPUTE \fBDST\fR WILL corrupt
the data source header in the \fBRRD\fR.
.PP
A second application of the \fBtune\fR function is to set or alter parameters
used by the specialized function \fBRRAs\fR for aberrant behavior detection.
.PP
Still another application is to add or remove data sources (DS) or
add / remove or alter some aspects of round-robin archives (RRA). These operations
are not really done in-place, but rather generate a new RRD file internally and
move it over the original file. Data is kept intact during these operations.
For even more in-depth modifications you may review the
\&\fB\-\-source\fR and \fB\-\-template\fR options of the \fBcreate\fR function which
allow you to combine multiple RRD files into a new one and which is even more clever
in what data it is able to keep or "regenerate".
.IP \fIfilename\fR 8
.IX Item "filename"
The name of the \fBRRD\fR you want to tune.
.IP \fB\-\-heartbeat\fR|\fB\-h\fR\ \fIds-name\fR:\fIheartbeat\fR 8
.IX Item "--heartbeat|-h\ ds-name:heartbeat"
modify the \fIheartbeat\fR of a data source. By setting this to a high
value the RRD will accept things like one value per day.
.IP \fB\-\-minimum\fR|\fB\-i\fR\ \fIds-name\fR:\fImin\fR 8
.IX Item "--minimum|-i\ ds-name:min"
alter the minimum value acceptable as input from the data source.
Setting \fImin\fR to 'U' will disable this limit.
.IP \fB\-\-maximum\fR|\fB\-a\fR\ \fIds-name\fR:\fImax\fR 8
.IX Item "--maximum|-a\ ds-name:max"
alter the maximum value acceptable as input from the data source.
Setting \fImax\fR to 'U' will disable this limit.
.IP \fB\-\-data\-source\-type\fR|\fB\-d\fR\ \fIds-name\fR:\fIDST\fR 8
.IX Item "--data-source-type|-d\ ds-name:DST"
alter the type \fBDST\fR of a data source.
.IP \fB\-\-data\-source\-rename\fR|\fB\-r\fR\ \fIold-name\fR:\fInew-name\fR 8
.IX Item "--data-source-rename|-r\ old-name:new-name"
rename a data source.
.IP \fB\-\-deltapos\fR|\fB\-p\fR\ \fIscale-value\fR 8
.IX Item "--deltapos|-p\ scale-value"
Alter the deviation scaling factor for the upper bound of the
confidence band used internally to calculate violations for the
FAILURES \fBRRA\fR. 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 \fBRRA\fR.
.IP \fB\-\-deltaneg\fR|\fB\-n\fR\ \fIscale-value\fR 8
.IX Item "--deltaneg|-n\ scale-value"
Alter the deviation scaling factor for the lower bound of the confidence band
used internally to calculate violations for the FAILURES \fBRRA\fR. The default
value is 2. As with \fB\-\-deltapos\fR, this argument is unrelated to the scale
factor chosen when graphing confidence bounds.
.IP \fB\-\-failure\-threshold\fR|\fB\-f\fR\ \fIfailure-threshold\fR 8
.IX Item "--failure-threshold|-f\ failure-threshold"
Alter the number of confidence bound violations that constitute a failure for
purposes of the FAILURES \fBRRA\fR. This must be an integer less than or equal to
the window length of the FAILURES \fBRRA\fR. 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.
.IP \fB\-\-window\-length\fR|\fB\-w\fR\ \fIwindow-length\fR 8
.IX Item "--window-length|-w\ window-length"
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 \fBRRA\fR and less than or equal to 28. Setting
this option will reset the count of violations to 0.
.IP \fB\-\-alpha\fR|\fB\-x\fR\ \fIadaption-parameter\fR 8
.IX Item "--alpha|-x\ adaption-parameter"
Alter the intercept adaptation parameter for the Holt-Winters
forecasting algorithm. This parameter must be between 0 and 1.
.IP \fB\-\-beta\fR|\fB\-y\fR\ \fIadaption-parameter\fR 8
.IX Item "--beta|-y\ adaption-parameter"
Alter the slope adaptation parameter for the Holt-Winters forecasting
algorithm. This parameter must be between 0 and 1.
.IP \fB\-\-gamma\fR|\fB\-z\fR\ \fIadaption-parameter\fR 8
.IX Item "--gamma|-z\ adaption-parameter"
Alter the seasonal coefficient adaptation parameter for the SEASONAL
\&\fBRRA\fR. This parameter must be between 0 and 1.
.IP \fB\-\-gamma\-deviation\fR|\fB\-v\fR\ \fIadaption-parameter\fR 8
.IX Item "--gamma-deviation|-v\ adaption-parameter"
Alter the seasonal deviation adaptation parameter for the DEVSEASONAL
\&\fBRRA\fR. This parameter must be between 0 and 1.
.IP \fB\-\-smoothing\-window\fR|\fB\-s\fR\ \fIfraction-of-season\fR 8
.IX Item "--smoothing-window|-s\ fraction-of-season"
Alter the size of the smoothing window for the SEASONAL \fBRRA\fR. This must
be between 0 and 1.
.IP \fB\-\-smoothing\-window\-deviation\fR|\fB\-S\fR\ \fIfraction-of-season\fR 8
.IX Item "--smoothing-window-deviation|-S\ fraction-of-season"
Alter the size of the smoothing window for the DEVSEASONAL \fBRRA\fR. This must
be between 0 and 1.
.IP \fB\-\-aberrant\-reset\fR|\fB\-b\fR\ \fIds-name\fR 8
.IX Item "--aberrant-reset|-b\ ds-name"
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 \fBRRA\fR, it sets the intercept and
slope coefficients to unknown. For the SEASONAL \fBRRA\fR, it sets all seasonal
coefficients to unknown. For the DEVSEASONAL \fBRRA\fR, it sets all seasonal
deviation coefficients to unknown. For the FAILURES \fBRRA\fR, it erases the
violation history. Note that reset does not erase past predictions
(the values of the HWPREDICT or MHWPREDICT \fBRRA\fR), predicted deviations (the
values of the DEVPREDICT \fBRRA\fR), or failure history (the values of the
FAILURES \fBRRA\fR).  This option will function even if not all the listed
\&\fBRRAs\fR are present.
.Sp
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.
.Sp
Use of this tuning option is advised when the behavior of the data source
time series changes in a drastic and permanent manner.
.IP "\fB\-\-step\fR|\fB\-t\fR \fInewstep\fR" 8
.IX Item "--step|-t newstep"
Changes the step size of the RRD to newstep.
.Sp
TODO: add proper documentation
.IP "\fB\-\-daemon\fR|\fB\-D\fR \fIaddress\fR" 8
.IX Item "--daemon|-D address"
\&\fBNOTE\fR: Because the \fB\-d\fR (small letter 'd') option was already taken, this
function (unlike most other) uses the capital letter 'D' for the one-letter
option to name the cache daemon.
.Sp
If given, \fBRRDtool\fR will try to connect to the caching daemon
rrdcached at \fIaddress\fR and will fail if the connection cannot be
established. If the connection is successfully established the data
for the \fIfilename\fR will be flushed before performing the
copy/modify operation. Afterwards the \fIfilename\fR will be
forgotten by the cache daemon, so that the next access using the
caching daemon will read the proper structure.
.Sp
This sequence of operations is designed to achieve a consistent overall
result with respect to
RRD internal file consistency when using one of the \fBDS\fR or \fBRRA\fR changing
operations (that is: the resulting file should always be a valid RRD file,
regardless of concurrent updates through the caching daemon).
Regarding data consistency such guarantees are not made: Without external
synchronization concurrent updates may be lost.
.Sp
For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
.IP \fBDEL:\fR\fIds-name\fR 8
.IX Item "DEL:ds-name"
Every data source named with a DEL specification will be removed.
The resulting RRD will miss both the definition and the data for that
data source. Multiple DEL specifications are permitted.
.IP \fBDS:\fR\fIds-spec\fR 8
.IX Item "DS:ds-spec"
For every such data source definition (for the exact syntax see the
\&\fBcreate\fR command), a new data source will be added to the RRD. Multiple DS
specifications are permitted.
.IP \fBDELRRA:\fR\fIindex\fR 8
.IX Item "DELRRA:index"
Removes the RRA with index \fIindex\fR. The index is zero-based,
that is the very first RRA has index 0.
.IP \fBRRA:\fR\fIrra-spec\fR 8
.IX Item "RRA:rra-spec"
For every such archive definition (for the exact syntax see the
\&\fBcreate\fR command), a new RRA will be added to the output
RRD. Multiple RRA specifications are permitted.
.IP \fBRRA#\fR\fIindex\fR:[+\-=]<number> 8
.IX Item "RRA#index:[+-=]<number>"
Adds/removes or sets the given number of rows for the RRA with index
<index>. The index is zero-based, that is the very first RRA has index 0.
.SH "EXAMPLE 1"
.IX Header "EXAMPLE 1"
\&\f(CW\*(C`rrdtool tune data.rrd \-h in:100000 \-h out:100000 \-h through:100000\*(C'\fR
.PP
Set the minimum required heartbeat for data sources 'in', 'out'
and 'through' to 100'000 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.
.SH "EXAMPLE 2"
.IX Header "EXAMPLE 2"
\&\f(CW\*(C`rrdtool tune monitor.rrd \-\-window\-length 5 \-\-failure\-threshold 3\*(C'\fR
.PP
If the FAILURES \fBRRA\fR is implicitly created, the default
window-length is 9 and 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.
.SH "EXAMPLE 3"
.IX Header "EXAMPLE 3"
\&\f(CW\*(C`rrdtool tune some.rrd DEL:a RRA#0:+10\*(C'\fR
.PP
Delete the data source named \fBa\fR and extend the very first archive by 10 rows.
This will in fact replace the input RRD with a new RRD keeping all existing data.
For most practical use cases this is identical to a real in-place modification.
.SH AUTHORS
.IX Header "AUTHORS"
Tobias Oetiker <tobi@oetiker.ch>, Peter Stamfest <peter@stamfest.at>