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<Listen> I<Host> [I<Port>]
  68
  69 =item B<Server> I<Host> [I<Port>]
  70
  71 In B<client mode> the B<Server> statement sets the server to send datagrams to.
  72 The statement may occur multiple times to send each datagram to multiple
  73 destinations.
  74
  75 In B<server mode> the B<Listen> statement sets the interfaces to bind to. When
  76 multiple statements are found the daemon will bind to multiple interfaces.
  77
  78 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
  79 the argument is a multicast address the daemon will join that multicast group.
  80
  81 If no B<Listen> statement is found the server tries join both, the IPv6
  82 multicast group and the IPv4 multicast group. If no B<Server> statement is
  83 found the client will try to send data to the IPv6 multicast group first. If
  84 that failes the client will try the IPv4 multicast group.
  85
  86 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
  87 multicast group is C<239.192.74.66>.
  88
  89 The optional I<Port> argument sets the port to use. It can either be given
  90 using a numeric port number or a service name. If the argument is omited the
  91 default port B<25826> is assumed.
  92
  93 =item B<MulticastTTL> I<1-255>
  94
  95 Set the time-to-live of multicast packets. The default is a TTL of C<1>.
  96
  97 =back
  98
  99 =head1 PLUGIN OPTIONS
 100
 101 Some Plugins may register own options. These options must be inclosed in a
 102 C<Plugin>-Section. Which options exist depends on the plugin used:
 103
 104 =head2 Plugin C<hddtemp>
 105
 106 =over 4
 107
 108 =item B<Host> I<Hostname>
 109
 110 Hostname to connect to. Defaults to B<127.0.0.1>.
 111
 112 =item B<Port> I<Port>
 113
 114 TCP-Port to connect to. Defaults to B<7634>.
 115
 116 =back
 117
 118 =head2 Plugin C<mysql>
 119
 120 =over 4
 121
 122 =item B<Host> I<Hostname>
 123
 124 Hostname of the database server. Defaults to B<localhost>.
 125
 126 =item B<User> I<Username>
 127
 128 Username to use when connecting to the database.
 129
 130 =item B<Password> I<Password>
 131
 132 Password needed to log into the database.
 133
 134 =item B<Database> I<Database>
 135
 136 Select this database. Defaults to I<no database> which is a perfecly reasonable
 137 option for what this plugin does.
 138
 139 =back
 140
 141 =head2 Plugin C<ping>
 142
 143 =over 4
 144
 145 =item B<Host> I<IP-address>
 146
 147 Host to ping periodically. This option may be repeated several times to ping
 148 multiple hosts.
 149
 150 =back
 151
 152 =head1 SEE ALSO
 153
 154 L<collectd(1)>
 155
 156 =head1 AUTHOR
 157
 158 Florian Forster E<lt>octo@verplant.orgE<gt>
 159
 160 =cut