src/collectd.conf.pod

   1 =head1 NAME
   2
   3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
   4
   5 =head1 SYNOPSIS
   6
   7   Mode Client
   8   DataDir /path/to/data/
   9   PIDFile /path/to/pidfile/collectd.pid
  10   LogFile /path/to/logfile/collectd.log
  11   Server  123.123.123.123
  12   Port    12345
  13
  14   LoadPlugin cpu
  15   LoadPlugin load
  16   LoadPlugin ping
  17
  18   <Plugin ping>
  19     Host example.org
  20     Host provider.net
  21   </Plugin>
  22
  23 =head1 DESCRIPTION
  24
  25 The syntax of collectd's config file is similar to the config file of the famos
  26 I<Apache Webserver>. Each line either ... FIXME
  27
  28 =head1 OPTIONS
  29
  30 The available options.. Blah blah blah
  31
  32 =head2 Glocal Options
  33
  34 =over 4
  35
  36 =item B<Mode> (B<Local>|B<Client>|B<Server>)
  37
  38 Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
  39 description. This option determines which other options are allowed.
  40
  41 =item B<LoadPlugin> I<Plugin>
  42
  43 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  44 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
  45
  46 =item B<PIDFile> I<File>
  47
  48 Sets where to write the PID file to. This file is overwritten when it exists
  49 and deleted when the program ist stopped. Available in B<all modes>.
  50
  51 =item B<DataDir> I<Directory>
  52
  53 Sets the data directory. This is the directory beneath all RRD-files are
  54 created. Possibly more subdirectories are created. This is also the working
  55 directory for the daemon. Available in B<all modes>, though the B<Server> mode
  56 won't write to this directory.
  57
  58 =item B<LogFile> I<File>
  59
  60 Sets the file to write debugging output to. This is only used if compiled with
  61 debugging enabled. It's ignored otherwise. Available in B<all modes>.
  62
  63 =item B<Server> I<Hostname or IP-address>
  64
  65 The server to send data to. B<This is not yet implemented!> Maybe a better name
  66 for this was B<Receiver>, since I plan on detecting multicast groups
  67 automatically. On the other hand a extra MulticastGroup-option would be of
  68 interest for the server process. Anyhow, right now this is available for the
  69 B<Client> mode only.
  70
  71 =item B<Port> I<Port number>
  72
  73 (UDP-)Port to send packages to or to bind to and wait for packages. This option
  74 is available in the B<Client> and B<Server> mode.
  75
  76 =back
  77
  78 =head2 Plugin options
  79
  80 =over
  81
  82 =item B<ping>-Plugin
  83
  84 =over 4
  85
  86 =item B<Host> I<Hostname or IP-address>
  87
  88 Host to ping periodically. This option may be repeated several times to ping
  89 multiple hosts.
  90
  91 =back
  92
  93 =back
  94
  95 =head1 SEE ALSO
  96
  97 L<collectd(1)>
  98
  99 =head1 AUTHOR
 100
 101 Florian Forster E<lt>octo@verplant.orgE<gt>
 102
 103 =cut