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 12345
  12
  13   LoadPlugin cpu
  14   LoadPlugin load
  15   LoadPlugin ping
  16
  17   <Plugin ping>
  18     Host example.org
  19     Host provider.net
  20   </Plugin>
  21
  22 =head1 DESCRIPTION
  23
  24 This config file controls how the system statistics collection daemon
  25 B<collectd> behaves. The most significant options are B<Mode>, which controlls
  26 if the daemon will act as client, server or will be independent in local mode,
  27 and B<LoadPlugin> which controls which plugins to load.
  28
  29 The syntax of this config file is similar to the config file of the famos
  30 B<Apache Webserver>. Each line containes either a key-value-pair or a
  31 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  32 ignored.
  33
  34 =head1 GLOBAL OPTIONS
  35
  36 =over 4
  37
  38 =item B<Mode> (B<Local>|B<Client>|B<Server>|B<Log>)
  39
  40 Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
  41 description. This option determines which other options are allowed. Defaults
  42 to B<Local>.
  43
  44 =item B<LoadPlugin> I<Plugin>
  45
  46 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  47 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
  48
  49 =item B<PIDFile> I<File>
  50
  51 Sets where to write the PID file to. This file is overwritten when it exists
  52 and deleted when the program ist stopped. Available in B<all modes>.
  53
  54 =item B<DataDir> I<Directory>
  55
  56 Sets the data directory. This is the directory beneath all RRD-files are
  57 created. Possibly more subdirectories are created. This is also the working
  58 directory for the daemon. Available in B<all modes>, though the B<Client> mode
  59 won't write to this directory.
  60
  61 =item B<LogFile> I<File>
  62
  63 Sets the file to write debugging output to. This is only used if compiled with
  64 debugging enabled. It's ignored otherwise. Available in B<all modes>.
  65
  66 =item B<Listen> I<Host> [I<Port>]
  67
  68 =item B<Server> I<Host> [I<Port>]
  69
  70 In B<client mode> the B<Server> statement sets the server to send datagrams to.
  71 The statement may occur multiple times to send each datagram to multiple
  72 destinations.
  73
  74 In B<server mode> the B<Listen> statement sets the interfaces to bind to. When
  75 multiple statements are found the daemon will bind to multiple interfaces.
  76
  77 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
  78 the argument is a multicast address the daemon will join that multicast group.
  79
  80 If no B<Listen> statement is found the server tries join both, the IPv6
  81 multicast group and the IPv4 multicast group. If no B<Server> statement is
  82 found the client will try to send data to the IPv6 multicast group first. If
  83 that failes the client will try the IPv4 multicast group.
  84
  85 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
  86 multicast group is C<239.192.74.66>.
  87
  88 The optional I<Port> argument sets the port to use. It can either be given
  89 using a numeric port number or a service name. If the argument is omited the
  90 default port B<25826> is assumed.
  91
  92 =item B<TimeToLive> I<1-255>
  93
  94 Set the time-to-live of sent packets. This applies to all, unicast and
  95 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
  96 That means that multicast packets will be sent with a TTL of C<1> (one) on most
  97 operating systems.
  98
  99 =back
 100
 101 =head1 PLUGIN OPTIONS
 102
 103 Some Plugins may register own options. These options must be inclosed in a
 104 C<Plugin>-Section. Which options exist depends on the plugin used:
 105
 106 =head2 Plugin C<apache>
 107
 108 To configure the C<apache>-plugin you first need to configure the Apache
 109 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 110 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 111 the following snipped to base your Apache config upon:
 112
 113   ExtendedStatus on
 114   <IfModule mod_status.c>
 115     <Location /mod_status>
 116       SetHandler server-status
 117     </Location>
 118   </IfModule>
 119
 120 The following options are accepted by the C<apache>-plugin:
 121
 122 =over 4
 123
 124 =item B<URL> I<http://host/mod_status?auto>
 125
 126 Sets the URL of the C<mod_status> output. This needs to be the output generated
 127 by C<ExtendedStatus on> and it needs to be the machine readable output
 128 generated by appending the C<?auto> argument.
 129
 130 =item B<User> I<Username>
 131
 132 Optional user name needed for authentication.
 133
 134 =item B<Password> I<Password>
 135
 136 Optional password needed for authentication.
 137
 138 =item B<CACert> I<File>
 139
 140 File that holds one or more SSL certificates. If you want to use HTTPS you will
 141 possibly need this option. What CA certificates come bundeled with C<libcurl>
 142 and are checked by default depends on the distribution you use.
 143
 144 =back
 145
 146 =head2 Plugin C<apcups>
 147
 148 =over 4
 149
 150 =item B<Host> I<Hostname>
 151
 152 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 153 that IPv6 support has been disabled unless someone can confirm or decline that
 154 B<apcupsd> can handle it.
 155
 156 =item B<Port> I<Port>
 157
 158 TCP-Port to connect to. Defaults to B<3551>.
 159
 160 =back
 161
 162 =head2 Plugin C<hddtemp>
 163
 164 =over 4
 165
 166 =item B<Host> I<Hostname>
 167
 168 Hostname to connect to. Defaults to B<127.0.0.1>.
 169
 170 =item B<Port> I<Port>
 171
 172 TCP-Port to connect to. Defaults to B<7634>.
 173
 174 =back
 175
 176 =head2 Plugin C<ntpd>
 177
 178 =over 4
 179
 180 =item B<Host> I<Hostname>
 181
 182 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 183
 184 =item B<Port> I<Port>
 185
 186 UDP-Port to connect to. Defaults to B<123>.
 187
 188 =back
 189
 190 =head2 Plugin C<mysql>
 191
 192 =over 4
 193
 194 =item B<Host> I<Hostname>
 195
 196 Hostname of the database server. Defaults to B<localhost>.
 197
 198 =item B<User> I<Username>
 199
 200 Username to use when connecting to the database.
 201
 202 =item B<Password> I<Password>
 203
 204 Password needed to log into the database.
 205
 206 =item B<Database> I<Database>
 207
 208 Select this database. Defaults to I<no database> which is a perfecly reasonable
 209 option for what this plugin does.
 210
 211 =back
 212
 213 =head2 Plugin C<ping>
 214
 215 =over 4
 216
 217 =item B<Host> I<IP-address>
 218
 219 Host to ping periodically. This option may be repeated several times to ping
 220 multiple hosts.
 221
 222 =item B<TTL> I<0-255>
 223
 224 Sets the Time-To-Live of generated ICMP packets.
 225
 226 =back
 227
 228 =head2 Plugin C<traffic>
 229
 230 =over 4
 231
 232 =item B<Interface> I<Interface>
 233
 234 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
 235
 236 =item B<IgnoreSelected> I<true>|I<false>
 237
 238 If no configuration if given, the B<traffic>-plugin will collect data from
 239 all interfaces. This may not be practical, especially for loopback- and
 240 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 241 interfaces you're interested in. Sometimes, however, it's easier/prefered
 242 to collect all interfaces I<except> a few ones. This option enables you to
 243 do that: By setting B<IgnoreSelected> to I<true> the effect of
 244 B<Interface> is inversed: All selected interfaces are ignored and all
 245 other interfaces are collected.
 246
 247 =back
 248
 249 =head1 SEE ALSO
 250
 251 L<collectd(1)>
 252
 253 =head1 AUTHOR
 254
 255 Florian Forster E<lt>octo@verplant.orgE<gt>
 256
 257 =cut