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   BaseDir "/path/to/data/"
   8   PIDFile "/path/to/pidfile/collectd.pid"
   9   LogFile "/path/to/logfile/collectd.log"
  10   Server  "123.123.123.123" 12345
  11
  12   LoadPlugin cpu
  13   LoadPlugin load
  14   LoadPlugin ping
  15
  16   <Plugin ping>
  17     Host "example.org"
  18     Host "provider.net"
  19   </Plugin>
  20
  21 =head1 DESCRIPTION
  22
  23 This config file controls how the system statistics collection daemon
  24 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  25 controls which plugins to load. These plugins ultimately define collectd's
  26 behavior.
  27
  28 The syntax of this config file is similar to the config file of the famos
  29 B<Apache Webserver>. Each line containes either a key-value-pair or a
  30 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  31 ignored. Values are either string, enclosed in double-quotes,
  32 (floating-point-)numbers or a boolean extression, i.E<nbsp>e. either B<true> or
  33 B<false>. String containing of only alphanumeric characters and underscores do
  34 not need to be quoted.
  35
  36 =head1 GLOBAL OPTIONS
  37
  38 =over 4
  39
  40 =item B<BaseDir> I<Directory>
  41
  42 Sets the base directory. This is the directory beneath all RRD-files are
  43 created. Possibly more subdirectories are created. This is also the working
  44 directory for the daemon.
  45
  46 =item B<LoadPlugin> I<Plugin>
  47
  48 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  49 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
  50
  51 =item B<PIDFile> I<File>
  52
  53 Sets where to write the PID file to. This file is overwritten when it exists
  54 and deleted when the program ist stopped. Some init-scripts might override this
  55 setting using the B<-P> commandline option.
  56
  57 =item B<LogFile> I<File>
  58
  59 Sets the file to write debugging output to. This is only used if compiled with
  60 debugging enabled. It's ignored otherwise.
  61
  62 =item B<Interval> I<Seconds>
  63
  64 Configures the interval in which to query the read plugins. Obviously smaller
  65 values lead to a higher system load produces by collectd, while higher values
  66 lead to more coarse statistics. Please note that changing this value may render
  67 your RRD-files unuseable, if you use the C<rrdtool plugin>. You have been
  68 warned.
  69
  70 =back
  71
  72 =head1 PLUGIN OPTIONS
  73
  74 Some Plugins may register own options. These options must be inclosed in a
  75 C<Plugin>-Section. Which options exist depends on the plugin used:
  76
  77 =head2 Plugin C<apache>
  78
  79 To configure the C<apache>-plugin you first need to configure the Apache
  80 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
  81 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
  82 the following snipped to base your Apache config upon:
  83
  84   ExtendedStatus on
  85   <IfModule mod_status.c>
  86     <Location /mod_status>
  87       SetHandler server-status
  88     </Location>
  89   </IfModule>
  90
  91 Since it's C<mod_status> module is very similar to Apache's, B<lighttpd> is
  92 also supported. It introduces a new field, called C<BusyServers>, to count the
  93 number of currently connected clients. This field is also supported.
  94
  95 The following options are accepted by the C<apache>-plugin:
  96
  97 =over 4
  98
  99 =item B<URL> I<http://host/mod_status?auto>
 100
 101 Sets the URL of the C<mod_status> output. This needs to be the output generated
 102 by C<ExtendedStatus on> and it needs to be the machine readable output
 103 generated by appending the C<?auto> argument.
 104
 105 =item B<User> I<Username>
 106
 107 Optional user name needed for authentication.
 108
 109 =item B<Password> I<Password>
 110
 111 Optional password needed for authentication.
 112
 113 =item B<CACert> I<File>
 114
 115 File that holds one or more SSL certificates. If you want to use HTTPS you will
 116 possibly need this option. What CA certificates come bundeled with C<libcurl>
 117 and are checked by default depends on the distribution you use.
 118
 119 =back
 120
 121 =head2 Plugin C<apcups>
 122
 123 =over 4
 124
 125 =item B<Host> I<Hostname>
 126
 127 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 128 that IPv6 support has been disabled unless someone can confirm or decline that
 129 B<apcupsd> can handle it.
 130
 131 =item B<Port> I<Port>
 132
 133 TCP-Port to connect to. Defaults to B<3551>.
 134
 135 =back
 136
 137 =head2 Plugin C<csv>
 138
 139 =over 4
 140
 141 =item B<DataDir> I<Directory>
 142
 143 Set the directory to store RRD-files under. Per default RRD-files are generated
 144 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 145
 146 =back
 147
 148 =head2 Plugin C<df>
 149
 150 =over 4
 151
 152 =item B<Device> I<Device>
 153
 154 Select partitions based on the devicename.
 155
 156 =item B<MountPoint> I<Directory>
 157
 158 Select partitions based on the mountpoint.
 159
 160 =item B<FSType> I<FSType>
 161
 162 Select partitions based on the filesystem type.
 163
 164 =item B<IgnoreSelected> I<true>|I<false>
 165
 166 Invert the selection: If set to true, all partitions B<except> the ones that
 167 match any one of the criteria are collected. By default only selected
 168 partitions are collected if a selection is made. If no selection is conifured
 169 at all, B<all> partitions are selected.
 170
 171 =back
 172
 173 =head2 Plugin C<dns>
 174
 175 =over 4
 176
 177 =item B<Interface> I<Interface>
 178
 179 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 180 option sets the interface that should be used. If this option is not set, or
 181 set to "any", the plugin will try to get packets from B<all> interfaces. This
 182 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 183
 184 =item B<IgnoreSource> I<IP-address>
 185
 186 Ignore packets that originate from this address.
 187
 188 =back
 189
 190 =head2 Plugin C<email>
 191
 192 =over 4
 193
 194 =item B<SocketGroup> I<Group>
 195
 196 If running as root change the group of the UNIX-socket after it has been
 197 created. Defaults to B<collectd>.
 198
 199 =item B<SocketPerms> I<Permissions>
 200
 201 Change the file permissions of the UNIX-socket after it has been created. The
 202 permissions must be given as a numeric, octal value as you would pass to
 203 L<chmod(1)>. Defaults to B<0770>.
 204
 205 =item B<MaxConns> I<Number>
 206
 207 Sets the maximum number of connections that can be handled in parallel. Since
 208 this many threads will be started immediately setting this to a very high
 209 value will waste valuable resources. Defaults to B<5> and will be forced to be
 210 at most B<16384> to prevent typos and dumb mistakes.
 211
 212 =back
 213
 214 =head2 Plugin C<hddtemp>
 215
 216 =over 4
 217
 218 =item B<Host> I<Hostname>
 219
 220 Hostname to connect to. Defaults to B<127.0.0.1>.
 221
 222 =item B<Port> I<Port>
 223
 224 TCP-Port to connect to. Defaults to B<7634>.
 225
 226 =back
 227
 228 =head2 Plugin C<irq>
 229
 230 =over 4
 231
 232 =item B<Irq> I<Irq>
 233
 234 Select this irq. By default these irqs will then be collected. For a more
 235 detailed description see B<IgnoreSelected> below.
 236
 237 =item B<IgnoreSelected> I<true>|I<false>
 238
 239 If no configuration if given, the B<irq>-plugin will collect data from all
 240 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 241 can use the B<Irq>-option to pick the interupt you're interested in.
 242 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 243 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 244 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 245 and all other interupts are collected.
 246
 247 =back
 248
 249 =head2 Plugin C<mbmon>
 250
 251 =over 4
 252
 253 =item B<Host> I<Hostname>
 254
 255 Hostname to connect to. Defaults to B<127.0.0.1>.
 256
 257 =item B<Port> I<Port>
 258
 259 TCP-Port to connect to. Defaults to B<411>.
 260
 261 =back
 262
 263 =head2 Plugin C<mysql>
 264
 265 =over 4
 266
 267 =item B<Host> I<Hostname>
 268
 269 Hostname of the database server. Defaults to B<localhost>.
 270
 271 =item B<User> I<Username>
 272
 273 Username to use when connecting to the database.
 274
 275 =item B<Password> I<Password>
 276
 277 Password needed to log into the database.
 278
 279 =item B<Database> I<Database>
 280
 281 Select this database. Defaults to I<no database> which is a perfecly reasonable
 282 option for what this plugin does.
 283
 284 =back
 285
 286 =head2 Plugin C<network>
 287
 288 =over 4
 289
 290 =item B<Listen> I<Host> [I<Port>]
 291
 292 =item B<Server> I<Host> [I<Port>]
 293
 294 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 295 may occur multiple times to send each datagram to multiple destinations.
 296
 297 The B<Listen> statement sets the interfaces to bind to. When multiple
 298 statements are found the daemon will bind to multiple interfaces.
 299
 300 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 301 the argument is a multicast address the daemon will join that multicast group.
 302
 303 If no B<Listen> statement is found the server tries join both, the default IPv6
 304 multicast group and the default IPv4 multicast group. If no B<Server> statement
 305 is found the client will try to send data to the IPv6 multicast group first. If
 306 that failes the client will try the IPv4 multicast group.
 307
 308 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 309 multicast group is C<239.192.74.66>.
 310
 311 The optional I<Port> argument sets the port to use. It can either be given
 312 using a numeric port number or a service name. If the argument is omited the
 313 default port B<25826> is assumed.
 314
 315 =item B<TimeToLive> I<1-255>
 316
 317 Set the time-to-live of sent packets. This applies to all, unicast and
 318 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 319 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 320 operating systems.
 321
 322 =back
 323
 324 =head2 Plugin C<ntpd>
 325
 326 =over 4
 327
 328 =item B<Host> I<Hostname>
 329
 330 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 331
 332 =item B<Port> I<Port>
 333
 334 UDP-Port to connect to. Defaults to B<123>.
 335
 336 =back
 337
 338 =head2 Plugin C<ping>
 339
 340 =over 4
 341
 342 =item B<Host> I<IP-address>
 343
 344 Host to ping periodically. This option may be repeated several times to ping
 345 multiple hosts.
 346
 347 =item B<TTL> I<0-255>
 348
 349 Sets the Time-To-Live of generated ICMP packets.
 350
 351 =back
 352
 353 =head2 Plugin C<rrdtool>
 354
 355 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 356 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 357 using these settings. If you don't want to dive into the depths of RRDTool, you
 358 can savely ignore these settings.
 359
 360 =over 4
 361
 362 =item B<DataDir> I<Directory>
 363
 364 Set the directory to store CSV-files under. Per default CSV-files are generated
 365 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 366
 367 =item B<StepSize> I<Seconds>
 368
 369 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 370 setting is identical to the global B<Interval>-option and should not be
 371 smaller. If unsure, don't set this option.
 372
 373 =item B<HeartBeat> I<Seconds>
 374
 375 Sets the heartbeat of newly created RRD-files. Ideally (and per default) this
 376 setting is bigger than the B<Interval>-setting. If unsure, don't set this
 377 option.
 378
 379 =item B<RRARows> I<NumRows>
 380
 381 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 382 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 383 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 384 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 385 week, one month, and one year.
 386
 387 So for each timespan, it calculates how many PDPs need to be consolidated into
 388 one CDP by calculating:
 389   number of PDPs = timespan / (stepsize * rrarows)
 390
 391 Bottom line is, set this no smaller than the width of you graphs in pixels.
 392
 393 =item B<XFF> I<Factor>
 394
 395 Set the "XFiles Factor". This is mostly interesting if you set B<StepSize>
 396 bigger than B<Interval>. If unsure, don't set this option.
 397
 398 =item B<CacheFlush> I<Seconds>
 399
 400 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 401 it writes all values for a certain RRD-file if the oldest value is older than
 402 (or equal to) the number of seconds specified. If some RRD-file is not updated
 403 anymore for some reason (the computer was shut down, the network is broken,
 404 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 405 entire cache is searched for entries older than B<CacheTimeout> seconds and
 406 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 407 does nothing under normal circumstances, this value should not be too small.
 408 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 409 normally do much harm either.
 410
 411 =item B<CacheTimeout> I<Seconds>
 412
 413 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 414 save values in a cache, as described above. Writing multiple values at once
 415 reduces IO-operations and thus lessens the load produced by updating the files.
 416 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 417 used.
 418
 419 =back
 420
 421 =head2 Plugin C<sensors>
 422
 423 =over 4
 424
 425 =item B<Sensor> I<chip-bus-address/type-feature>
 426
 427 Selects the name of the sensor which you want to collect or ignore, depending
 428 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 429 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 430 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 431
 432 =item B<IgnoreSelected> I<true>|I<false>
 433
 434 If no configuration if given, the B<sensors>-plugin will collect data from all
 435 sensors. This may not be practical, especially for uninteresting sensors.
 436 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 437 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
 438 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 439 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 440 and all other sensors are collected.
 441
 442 =back
 443
 444 =head2 Plugin C<traffic>
 445
 446 =over 4
 447
 448 =item B<Interface> I<Interface>
 449
 450 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
 451
 452 =item B<IgnoreSelected> I<true>|I<false>
 453
 454 If no configuration if given, the B<traffic>-plugin will collect data from
 455 all interfaces. This may not be practical, especially for loopback- and
 456 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 457 interfaces you're interested in. Sometimes, however, it's easier/prefered
 458 to collect all interfaces I<except> a few ones. This option enables you to
 459 do that: By setting B<IgnoreSelected> to I<true> the effect of
 460 B<Interface> is inversed: All selected interfaces are ignored and all
 461 other interfaces are collected.
 462
 463 =back
 464
 465 =head1 SEE ALSO
 466
 467 L<collectd(1)>
 468
 469 =head1 AUTHOR
 470
 471 Florian Forster E<lt>octo@verplant.orgE<gt>
 472
 473 =cut