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 This config file controls how the system statistics collection daemon
  26 B<collectd> behaves. The most significant options are B<Mode>, which controlls
  27 if the daemon will act as client, server or will be independent in local mode,
  28 and B<LoadPlugin> which controls which plugins to load.
  29
  30 The syntax of this config file is similar to the config file of the famos
  31 B<Apache Webserver>. Each line containes either a key-value-pair or a
  32 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  33 ignored.
  34
  35 =head1 GLOBAL OPTIONS
  36
  37 =over 4
  38
  39 =item B<Mode> (B<Local>|B<Client>|B<Server>)
  40
  41 Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
  42 description. This option determines which other options are allowed. Defaults
  43 to B<Local>.
  44
  45 =item B<LoadPlugin> I<Plugin>
  46
  47 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  48 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
  49
  50 =item B<PIDFile> I<File>
  51
  52 Sets where to write the PID file to. This file is overwritten when it exists
  53 and deleted when the program ist stopped. Available in B<all modes>.
  54
  55 =item B<DataDir> I<Directory>
  56
  57 Sets the data directory. This is the directory beneath all RRD-files are
  58 created. Possibly more subdirectories are created. This is also the working
  59 directory for the daemon. Available in B<all modes>, though the B<Server> mode
  60 won't write to this directory.
  61
  62 =item B<LogFile> I<File>
  63
  64 Sets the file to write debugging output to. This is only used if compiled with
  65 debugging enabled. It's ignored otherwise. Available in B<all modes>.
  66
  67 =item B<Server> I<IP-address>
  68
  69 The server to send data to. B<This is not yet implemented!> Maybe a better name
  70 for this was B<Receiver>, since I plan on detecting multicast groups
  71 automatically. On the other hand a extra MulticastGroup-option would be of
  72 interest for the server process. Anyhow, right now this is available for the
  73 B<Client> mode only.
  74
  75 =item B<Port> I<Port-number>
  76
  77 (UDP-)Port to send packages to or to bind to and wait for packages. This option
  78 is available in the B<Client> and B<Server> mode.
  79
  80 =back
  81
  82 =head1 PLUGIN OPTIONS
  83
  84 Some Plugins may register own options. These options must be inclosed in a
  85 C<Plugin>-Section. Which options exist depends on the plugin used:
  86
  87 =head2 Plugin C<hddtemp>
  88
  89 =over 4
  90
  91 =item B<Host> I<Hostname>
  92
  93 Hostname to connect to. Defaults to B<127.0.0.1>.
  94
  95 =item B<Port> I<Port>
  96
  97 TCP-Port to connect to. Defaults to B<7634>.
  98
  99 =back
 100
 101 =head2 Plugin C<mysql>
 102
 103 =over 4
 104
 105 =item B<Host> I<Hostname>
 106
 107 Hostname of the database server. Defaults to B<localhost>.
 108
 109 =item B<User> I<Username>
 110
 111 Username to use when connecting to the database.
 112
 113 =item B<Password> I<Password>
 114
 115 Password needed to log into the database.
 116
 117 =item B<Database> I<Database>
 118
 119 Select this database. Defaults to I<no database> which is a perfecly reasonable
 120 option for what this plugin does.
 121
 122 =back
 123
 124 =head2 Plugin C<ping>
 125
 126 =over 4
 127
 128 =item B<Host> I<IP-address>
 129
 130 Host to ping periodically. This option may be repeated several times to ping
 131 multiple hosts.
 132
 133 =back
 134
 135 =head1 SEE ALSO
 136
 137 L<collectd(1)>
 138
 139 =head1 AUTHOR
 140
 141 Florian Forster E<lt>octo@verplant.orgE<gt>
 142
 143 =cut