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. Some init-scripts might override this
  53 setting using the B<-P> commandline option. 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<Client> 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<TimeToLive> I<1-255>
  94
  95 Set the time-to-live of sent packets. This applies to all, unicast and
  96 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
  97 That means that multicast packets will be sent with a TTL of C<1> (one) on most
  98 operating systems.
  99
 100 =back
 101
 102 =head1 PLUGIN OPTIONS
 103
 104 Some Plugins may register own options. These options must be inclosed in a
 105 C<Plugin>-Section. Which options exist depends on the plugin used:
 106
 107 =head2 Plugin C<apache>
 108
 109 To configure the C<apache>-plugin you first need to configure the Apache
 110 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 111 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 112 the following snipped to base your Apache config upon:
 113
 114   ExtendedStatus on
 115   <IfModule mod_status.c>
 116     <Location /mod_status>
 117       SetHandler server-status
 118     </Location>
 119   </IfModule>
 120
 121 Since it's C<mod_status> module is very similar to Apache's, B<lighttpd> is
 122 also supported. It introduces a new field, called C<BusyServers>, to count the
 123 number of currently connected clients. This field is also supported.
 124
 125 The following options are accepted by the C<apache>-plugin:
 126
 127 =over 4
 128
 129 =item B<URL> I<http://host/mod_status?auto>
 130
 131 Sets the URL of the C<mod_status> output. This needs to be the output generated
 132 by C<ExtendedStatus on> and it needs to be the machine readable output
 133 generated by appending the C<?auto> argument.
 134
 135 =item B<User> I<Username>
 136
 137 Optional user name needed for authentication.
 138
 139 =item B<Password> I<Password>
 140
 141 Optional password needed for authentication.
 142
 143 =item B<CACert> I<File>
 144
 145 File that holds one or more SSL certificates. If you want to use HTTPS you will
 146 possibly need this option. What CA certificates come bundeled with C<libcurl>
 147 and are checked by default depends on the distribution you use.
 148
 149 =back
 150
 151 =head2 Plugin C<apcups>
 152
 153 =over 4
 154
 155 =item B<Host> I<Hostname>
 156
 157 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 158 that IPv6 support has been disabled unless someone can confirm or decline that
 159 B<apcupsd> can handle it.
 160
 161 =item B<Port> I<Port>
 162
 163 TCP-Port to connect to. Defaults to B<3551>.
 164
 165 =back
 166
 167 =head2 Plugin C<df>
 168
 169 =over 4
 170
 171 =item B<Device> I<Device>
 172
 173 Select partitions based on the devicename.
 174
 175 =item B<MountPoint> I<Directory>
 176
 177 Select partitions based on the mountpoint.
 178
 179 =item B<FSType> I<FSType>
 180
 181 Select partitions based on the filesystem type.
 182
 183 =item B<IgnoreSelected> I<true>|I<false>
 184
 185 Invert the selection: If set to true, all partitions B<except> the ones that
 186 match any one of the criteria are collected. By default only selected
 187 partitions are collected if a selection is made. If no selection is conifured
 188 at all, B<all> partitions are selected.
 189
 190 =back
 191
 192 =head2 Plugin C<dns>
 193
 194 =over 4
 195
 196 =item B<Interface> I<Interface>
 197
 198 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 199 option sets the interface that should be used. If this option is not set, or
 200 set to "any", the plugin will try to get packets from B<all> interfaces. This
 201 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 202
 203 =item B<IgnoreSource> I<IP-address>
 204
 205 Ignore packets that originate from this address.
 206
 207 =back
 208
 209 =head2 Plugin C<email>
 210
 211 =over 4
 212
 213 =item B<SocketGroup> I<Group>
 214
 215 If running as root change the group of the UNIX-socket after it has been
 216 created. Defaults to B<collectd>.
 217
 218 =item B<SocketPerms> I<Permissions>
 219
 220 Change the file permissions of the UNIX-socket after it has been created. The
 221 permissions must be given as a numeric, octal value as you would pass to
 222 L<chmod(1)>. Defaults to B<0770>.
 223
 224 =item B<MaxConns> I<Number>
 225
 226 Sets the maximum number of connections that can be handled in parallel. Since
 227 this many threads will be started immediately setting this to a very high
 228 value will waste valuable resources. Defaults to B<5> and will be forced to be
 229 at most B<16384> to prevent typos and dumb mistakes.
 230
 231 =back
 232
 233 =head2 Plugin C<hddtemp>
 234
 235 =over 4
 236
 237 =item B<Host> I<Hostname>
 238
 239 Hostname to connect to. Defaults to B<127.0.0.1>.
 240
 241 =item B<Port> I<Port>
 242
 243 TCP-Port to connect to. Defaults to B<7634>.
 244
 245 =back
 246
 247 =head2 Plugin C<irq>
 248
 249 =over 4
 250
 251 =item B<Irq> I<Irq>
 252
 253 Select this irq. By default these irqs will then be collected. For a more
 254 detailed description see B<IgnoreSelected> below.
 255
 256 =item B<IgnoreSelected> I<true>|I<false>
 257
 258 If no configuration if given, the B<irq>-plugin will collect data from all
 259 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 260 can use the B<Irq>-option to pick the interupt you're interested in.
 261 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 262 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 263 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 264 and all other interupts are collected.
 265
 266 =back
 267
 268 =head2 Plugin C<mbmon>
 269
 270 =over 4
 271
 272 =item B<Host> I<Hostname>
 273
 274 Hostname to connect to. Defaults to B<127.0.0.1>.
 275
 276 =item B<Port> I<Port>
 277
 278 TCP-Port to connect to. Defaults to B<411>.
 279
 280 =back
 281
 282 =head2 Plugin C<ntpd>
 283
 284 =over 4
 285
 286 =item B<Host> I<Hostname>
 287
 288 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 289
 290 =item B<Port> I<Port>
 291
 292 UDP-Port to connect to. Defaults to B<123>.
 293
 294 =back
 295
 296 =head2 Plugin C<mysql>
 297
 298 =over 4
 299
 300 =item B<Host> I<Hostname>
 301
 302 Hostname of the database server. Defaults to B<localhost>.
 303
 304 =item B<User> I<Username>
 305
 306 Username to use when connecting to the database.
 307
 308 =item B<Password> I<Password>
 309
 310 Password needed to log into the database.
 311
 312 =item B<Database> I<Database>
 313
 314 Select this database. Defaults to I<no database> which is a perfecly reasonable
 315 option for what this plugin does.
 316
 317 =back
 318
 319 =head2 Plugin C<ping>
 320
 321 =over 4
 322
 323 =item B<Host> I<IP-address>
 324
 325 Host to ping periodically. This option may be repeated several times to ping
 326 multiple hosts.
 327
 328 =item B<TTL> I<0-255>
 329
 330 Sets the Time-To-Live of generated ICMP packets.
 331
 332 =back
 333
 334 =head2 Plugin C<sensors>
 335
 336 =over 4
 337
 338 =item B<ExtendedSensorNaming> I<true>|I<false>
 339
 340 If set to I<true> this option switches on the extended sensors and RRD-files
 341 naming. This option exists to preserve backwards compatibility. It is
 342 recommended that you set this option to I<true>. The default is I<false> to
 343 maintain compatibility only.
 344
 345 Sensors get names like I<chip-bus-address/type-feature> (e.g.
 346 I<it8712-isa-0290/voltage-in1>) and RRD files are therefore stored in a
 347 standalone directory inside the B<DataDir> directory and get names like
 348 I<lm_sensors-chip-bus-address/type-feature.rrd> (e.g.
 349 I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
 350
 351 The B<ExtendedSensorNaming> option breaks the compatibility with previous
 352 sensors and RRD files naming and the place where RRDs are stored. If you turn
 353 it on, the plugin will create new RRD files in a standalone directory inside
 354 the B<DataDir> directory and without previous history. You can rename ``old''
 355 RRD-files to preserve already collected statistics, because the file layout
 356 hasn't changed. If you have two chips of the same type, you need to use
 357 B<ExtendedSensorNaming> in order to collect information from both chips.
 358
 359 If not set or set to I<false>, the extended naming is not active. Sensors get
 360 names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files are stored in the
 361 main B<DataDir> directory and get names like I<sensors-chip-feature.rrd> (e.g.
 362 I<sensors-it8712-in1.rrd>).  You simply continue using the plugin the old way
 363 and additionally also getting data for newly added sensors in this mode.
 364
 365 =item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>
 366
 367 Both option modes select the name of the sensor which you want to collect.
 368 The naming scheme is dependent on the state of the B<ExtendedSensorNaming>
 369 option (see previous option). Both option modes can also deselect the
 370 sensor according to the B<IgnoreSelected> option (see below).
 371
 372 For example the option "B<Sensor> I<it8712-in1>" will cause the collectd
 373 to gather data for the voltage sensor I<in1> of the I<it8712> chip in case
 374 of the B<ExtendedSensorNaming> option is set to I<false>.
 375
 376 And likewise the option "B<Sensor> I<it8712-isa-0290/voltage-in1>" will
 377 cause the collectd to gather data for the voltage sensor I<in1> of the I<it8712>
 378 on the isa bus at the address 0290 in case of the B<ExtendedSensorNaming>
 379 option set to I<true>.
 380
 381 =item B<IgnoreSelected> I<true>|I<false>
 382
 383 If no configuration if given, the B<sensors>-plugin will collect data from
 384 all sensors. This may not be practical, especially for uninteresting sensors.
 385 Thus, you can use the B<Sensor>-option to pick the sensors you're
 386 interested in. Sometimes, however, it's easier/prefered to collect all
 387 sensors I<except> a few ones. This option enables you to
 388 do that: By setting B<IgnoreSelected> to I<true> the effect of
 389 B<Sensor> is inversed: All selected sensors are ignored and all
 390 other sensors are collected.
 391
 392 back
 393
 394 =back
 395
 396 =head2 Plugin C<traffic>
 397
 398 =over 4
 399
 400 =item B<Interface> I<Interface>
 401
 402 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
 403
 404 =item B<IgnoreSelected> I<true>|I<false>
 405
 406 If no configuration if given, the B<traffic>-plugin will collect data from
 407 all interfaces. This may not be practical, especially for loopback- and
 408 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 409 interfaces you're interested in. Sometimes, however, it's easier/prefered
 410 to collect all interfaces I<except> a few ones. This option enables you to
 411 do that: By setting B<IgnoreSelected> to I<true> the effect of
 412 B<Interface> is inversed: All selected interfaces are ignored and all
 413 other interfaces are collected.
 414
 415 =back
 416
 417 =head1 SEE ALSO
 418
 419 L<collectd(1)>
 420
 421 =head1 AUTHOR
 422
 423 Florian Forster E<lt>octo@verplant.orgE<gt>
 424
 425 =cut