doc/rrdtune.pod

   1 =head1 NAME
   2
   3 rrdtool tune - Modify some basic properties of a Round Robin Database
   4
   5 =for html <div align="right"><a href="rrdtune.pdf">PDF</a> version.</div>
   6
   7 =head1 SYNOPSIS
   8
   9 B<rrdtool> B<tune> I<filename>
  10 S<[B<--heartbeat>|B<-h> I<ds-name>:I<heartbeat>]>
  11 S<[B<--minimum>|B<-i> I<ds-name>:I<min>]>
  12 S<[B<--maximum>|B<-a> I<ds-name>:I<max>]>
  13 S<[B<--data-source-type>|B<-d> I<ds-name>:I<DST>]>
  14 S<[B<--data-source-rename>|B<-r> I<old-name>:I<new-name>]>
  15
  16 =head1 DESCRIPTION
  17
  18 The tune option allows you to alter some of the basic configuration
  19 values stored in the header area of a Round Robin Database (B<RRD>).
  20 All these tunable parameters together decide when data fed into an
  21 B<RRD> is to be regarded as invalid. Invalid data is entered into the
  22 database as *UNKNOWN*.
  23
  24 The main application of the B<tune> function is to relax the
  25 validation rules on an B<RRD>. This allows to fill a new B<RRD> with
  26 data available in larger intervals than what you would normally want
  27 to permit.
  28
  29 =over 8
  30
  31 =item I<filename>
  32
  33 The name of the B<RRD> you want to tune.
  34
  35 =item S<B<--heartbeat>|B<-h> I<ds-name>:I<heartbeat>>
  36
  37 modify the I<heartbeat> of a data source. By setting this to a high
  38 value the rrd will accept things like one value per day ...
  39
  40 =item S<B<--minimum>|B<-i> I<ds-name>:I<min>>
  41
  42 alter the minimum value acceptable as input from the data source.
  43 Setting I<min> to 'U' will disable this limit.
  44
  45 =item S<B<--maximum>|B<-a> I<ds-name>:I<max>>
  46
  47 alter the maximum value acceptable as input from the data source.
  48 Setting I<max> to 'U' will disable this limit.
  49
  50 =item S<B<--data-source-type>|B<-d> I<ds-name>:I<DST>>
  51
  52 alter the type B<DST> of a data source.
  53
  54 =item S<[B<--data-source-rename>|B<-r> I<old-name>:I<new-name>]>
  55
  56 rename a data source
  57
  58 =back
  59
  60 =head1 EXAMPLE
  61
  62 C<rrdtool tune data.rrd -h in:100000 -h out:100000 -h through:100000>
  63
  64 Set the minimum required heartbeat for data sources 'in', 'out'
  65 and 'through' to 10000 seconds which is a little over one day in data.rrd.
  66 This would allow to feed old data from mrtg-2.0 right into
  67 rrdtool without generating *UNKNOWN* entries.
  68
  69 =head1 AUTHOR
  70
  71 Tobias Oetiker <oetiker@ee.ethz.ch>
  72