doc/rrdcached.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 rrdcached - Data caching daemon for rrdtool
   6
   7 =head1 SYNOPSIS
   8
   9 B<rrdcached> [B<-l> I<address>] [B<-w> I<timeout>] [B<-f> I<timeout>]
  10
  11 =head1 DESCRIPTION
  12
  13 B<rrdcached> is a daemon that receives updates to existing RRD files,
  14 accumulates them and, if enough have been received or a defined time has
  15 passed, writes the updates to the RRD file. A I<flush> command may be used to
  16 force writing of values to disk, so that graphing facilities and similar can
  17 work with up-to-date data.
  18
  19 =head1 OPTIONS
  20
  21 =over 4
  22
  23 =item B<-l> I<address>
  24
  25 Tells the daemon to bind to I<address> and accept incoming connections on that
  26 socket. If I<address> begins with C<unix:>, everything following that prefix is
  27 interpreted as the path to a UNIX domain socket. Otherwise the address or node
  28 name are resolved using L<getaddrinfo(3)>.
  29
  30 If the B<-l> option is not specified the default address,
  31 C<unix:/tmp/rrdcached.sock>, will be used.
  32
  33 =item B<-w> I<timeout>
  34
  35 Data is written to disk every I<timeout> seconds. If this option is not
  36 specified the default interval of 300E<nbsp>seconds will be used.
  37
  38 =item B<-f> I<timeout>
  39
  40 Every I<timeout> seconds the entire cache is searched for old values which are
  41 written to disk. This only concerns files to which updates have stopped, so
  42 setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
  43 cases. This timeout defaults to 3600E<nbsp>seconds.
  44
  45 =item B<-p> I<file>
  46
  47 Sets the name and location of the PID-file. If not specified, the default,
  48 C<I<$localststedir>/run/rrdcached.pid> will be used.
  49
  50 =item B<-b> I<dir>
  51
  52 The daemon will change into a specific directory at startup. All files passed
  53 to the daemon, that are specified by a B<relative> path, will be interpreted
  54 to be relative to this directory. If not given the default, C</tmp>, will be
  55 used.
  56
  57   +------------------------+------------------------+
  58   ! Command line           ! File updated           !
  59   +------------------------+------------------------+
  60   ! foo.rrd                ! /tmp/foo.rrd           !
  61   ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
  62   ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
  63   +------------------------+------------------------+
  64   Paths given on the command  line and paths actually
  65   updated by the daemon,  assuming the base directory
  66   "/tmp".
  67
  68 =back
  69
  70 =head1 SEE ALSO
  71
  72 L<rrdtool(1)>, L<rrdgraph(1)>
  73
  74 =head1 AUHOR
  75
  76 B<rrdcached> and this manual page have been written by Florian Forster
  77 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.