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   Server  "123.123.123.123" 12345
  10
  11   LoadPlugin cpu
  12   LoadPlugin load
  13   LoadPlugin ping
  14
  15   <Plugin ping>
  16     Host "example.org"
  17     Host "provider.net"
  18   </Plugin>
  19
  20 =head1 DESCRIPTION
  21
  22 This config file controls how the system statistics collection daemon
  23 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  24 controls which plugins to load. These plugins ultimately define collectd's
  25 behavior.
  26
  27 The syntax of this config file is similar to the config file of the famos
  28 B<Apache Webserver>. Each line containes either a key-value-pair or a
  29 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  30 ignored. Values are either string, enclosed in double-quotes,
  31 (floating-point-)numbers or a boolean extression, i.E<nbsp>e. either B<true> or
  32 B<false>. String containing of only alphanumeric characters and underscores do
  33 not need to be quoted.
  34
  35 =head1 GLOBAL OPTIONS
  36
  37 =over 4
  38
  39 =item B<BaseDir> I<Directory>
  40
  41 Sets the base directory. This is the directory beneath all RRD-files are
  42 created. Possibly more subdirectories are created. This is also the working
  43 directory for the daemon.
  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. Some init-scripts might override this
  54 setting using the B<-P> commandline option.
  55
  56 =item B<Interval> I<Seconds>
  57
  58 Configures the interval in which to query the read plugins. Obviously smaller
  59 values lead to a higher system load produces by collectd, while higher values
  60 lead to more coarse statistics.
  61
  62 =item B<ReadThreads> I<Num>
  63
  64 Number of threads to start for reading plugins. The default value if B<5>, but
  65 you may want to increase this if you have more than five plugins that take a
  66 long time to read. Mostly those are plugin that do network-IO. Setting this to
  67 a value higher than the number of plugins you've loaded is totally useless.
  68
  69 =back
  70
  71 =head1 PLUGIN OPTIONS
  72
  73 Some Plugins may register own options. These options must be inclosed in a
  74 C<Plugin>-Section. Which options exist depends on the plugin used:
  75
  76 =head2 Plugin C<apache>
  77
  78 To configure the C<apache>-plugin you first need to configure the Apache
  79 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
  80 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
  81 the following snipped to base your Apache config upon:
  82
  83   ExtendedStatus on
  84   <IfModule mod_status.c>
  85     <Location /mod_status>
  86       SetHandler server-status
  87     </Location>
  88   </IfModule>
  89
  90 Since it's C<mod_status> module is very similar to Apache's, B<lighttpd> is
  91 also supported. It introduces a new field, called C<BusyServers>, to count the
  92 number of currently connected clients. This field is also supported.
  93
  94 The following options are accepted by the C<apache>-plugin:
  95
  96 =over 4
  97
  98 =item B<URL> I<http://host/mod_status?auto>
  99
 100 Sets the URL of the C<mod_status> output. This needs to be the output generated
 101 by C<ExtendedStatus on> and it needs to be the machine readable output
 102 generated by appending the C<?auto> argument.
 103
 104 =item B<User> I<Username>
 105
 106 Optional user name needed for authentication.
 107
 108 =item B<Password> I<Password>
 109
 110 Optional password needed for authentication.
 111
 112 =item B<CACert> I<File>
 113
 114 File that holds one or more SSL certificates. If you want to use HTTPS you will
 115 possibly need this option. What CA certificates come bundeled with C<libcurl>
 116 and are checked by default depends on the distribution you use.
 117
 118 =back
 119
 120 =head2 Plugin C<apcups>
 121
 122 =over 4
 123
 124 =item B<Host> I<Hostname>
 125
 126 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 127 that IPv6 support has been disabled unless someone can confirm or decline that
 128 B<apcupsd> can handle it.
 129
 130 =item B<Port> I<Port>
 131
 132 TCP-Port to connect to. Defaults to B<3551>.
 133
 134 =back
 135
 136 =head2 Plugin C<csv>
 137
 138 =over 4
 139
 140 =item B<DataDir> I<Directory>
 141
 142 Set the directory to store RRD-files under. Per default RRD-files are generated
 143 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 144
 145 =back
 146
 147 =head2 Plugin C<df>
 148
 149 =over 4
 150
 151 =item B<Device> I<Device>
 152
 153 Select partitions based on the devicename.
 154
 155 =item B<MountPoint> I<Directory>
 156
 157 Select partitions based on the mountpoint.
 158
 159 =item B<FSType> I<FSType>
 160
 161 Select partitions based on the filesystem type.
 162
 163 =item B<IgnoreSelected> I<true>|I<false>
 164
 165 Invert the selection: If set to true, all partitions B<except> the ones that
 166 match any one of the criteria are collected. By default only selected
 167 partitions are collected if a selection is made. If no selection is conifured
 168 at all, B<all> partitions are selected.
 169
 170 =back
 171
 172 =head2 Plugin C<dns>
 173
 174 =over 4
 175
 176 =item B<Interface> I<Interface>
 177
 178 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 179 option sets the interface that should be used. If this option is not set, or
 180 set to "any", the plugin will try to get packets from B<all> interfaces. This
 181 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 182
 183 =item B<IgnoreSource> I<IP-address>
 184
 185 Ignore packets that originate from this address.
 186
 187 =back
 188
 189 =head2 Plugin C<email>
 190
 191 =over 4
 192
 193 =item B<SocketGroup> I<Group>
 194
 195 If running as root change the group of the UNIX-socket after it has been
 196 created. Defaults to B<collectd>.
 197
 198 =item B<SocketPerms> I<Permissions>
 199
 200 Change the file permissions of the UNIX-socket after it has been created. The
 201 permissions must be given as a numeric, octal value as you would pass to
 202 L<chmod(1)>. Defaults to B<0770>.
 203
 204 =item B<MaxConns> I<Number>
 205
 206 Sets the maximum number of connections that can be handled in parallel. Since
 207 this many threads will be started immediately setting this to a very high
 208 value will waste valuable resources. Defaults to B<5> and will be forced to be
 209 at most B<16384> to prevent typos and dumb mistakes.
 210
 211 =back
 212
 213 =head2 Plugin C<hddtemp>
 214
 215 =over 4
 216
 217 =item B<Host> I<Hostname>
 218
 219 Hostname to connect to. Defaults to B<127.0.0.1>.
 220
 221 =item B<Port> I<Port>
 222
 223 TCP-Port to connect to. Defaults to B<7634>.
 224
 225 =back
 226
 227 =head2 Plugin C<interface>
 228
 229 =over 4
 230
 231 =item B<Interface> I<Interface>
 232
 233 Select this interface. By default these interfaces will then be collected. For
 234 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 =head2 Plugin C<iptables>
 250
 251 =over 4
 252
 253 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
 254
 255 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
 256 will collect the counters of all rules which have a comment-match. The comment
 257 is then used as type-instance.
 258
 259 If I<Comment> or I<Number> is given, only the rule with the matching comment or
 260 the I<n>th rule will be collected. Again, the comment (or the number) will be
 261 used as the type-instance.
 262
 263 If I<Name> is supplied, it will be used as the type-instance instead of the
 264 comment or the number.
 265
 266 =back
 267
 268 =head2 Plugin C<irq>
 269
 270 =over 4
 271
 272 =item B<Irq> I<Irq>
 273
 274 Select this irq. By default these irqs will then be collected. For a more
 275 detailed description see B<IgnoreSelected> below.
 276
 277 =item B<IgnoreSelected> I<true>|I<false>
 278
 279 If no configuration if given, the B<irq>-plugin will collect data from all
 280 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 281 can use the B<Irq>-option to pick the interupt you're interested in.
 282 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 283 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 284 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 285 and all other interupts are collected.
 286
 287 =back
 288
 289 =head2 Plugin C<logfile>
 290
 291 =over 4
 292
 293 =item B<LogLevel> B<debug|info|notice|warning|err>
 294
 295 Sets the log-level. If, for example, set to B<notice>, then all events with
 296 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
 297
 298 =item B<File> I<File>
 299
 300 Sets the file to write log messages to. The special strings B<stdout> and
 301 B<stderr> can be used to write to the standard output and standard error
 302 channels, respectively. This, of course, only makes much sense when collectd is
 303 running in foreground- or non-daemon-mode.
 304
 305 =back
 306
 307 =head2 Plugin C<mbmon>
 308
 309 =over 4
 310
 311 =item B<Host> I<Hostname>
 312
 313 Hostname to connect to. Defaults to B<127.0.0.1>.
 314
 315 =item B<Port> I<Port>
 316
 317 TCP-Port to connect to. Defaults to B<411>.
 318
 319 =back
 320
 321 =head2 Plugin C<mysql>
 322
 323 =over 4
 324
 325 =item B<Host> I<Hostname>
 326
 327 Hostname of the database server. Defaults to B<localhost>.
 328
 329 =item B<User> I<Username>
 330
 331 Username to use when connecting to the database.
 332
 333 =item B<Password> I<Password>
 334
 335 Password needed to log into the database.
 336
 337 =item B<Database> I<Database>
 338
 339 Select this database. Defaults to I<no database> which is a perfecly reasonable
 340 option for what this plugin does.
 341
 342 =back
 343
 344 =head2 Plugin C<network>
 345
 346 =over 4
 347
 348 =item B<Listen> I<Host> [I<Port>]
 349
 350 =item B<Server> I<Host> [I<Port>]
 351
 352 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 353 may occur multiple times to send each datagram to multiple destinations.
 354
 355 The B<Listen> statement sets the interfaces to bind to. When multiple
 356 statements are found the daemon will bind to multiple interfaces.
 357
 358 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 359 the argument is a multicast address the daemon will join that multicast group.
 360
 361 If no B<Listen> statement is found the server tries join both, the default IPv6
 362 multicast group and the default IPv4 multicast group. If no B<Server> statement
 363 is found the client will try to send data to the IPv6 multicast group first. If
 364 that failes the client will try the IPv4 multicast group.
 365
 366 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 367 multicast group is C<239.192.74.66>.
 368
 369 The optional I<Port> argument sets the port to use. It can either be given
 370 using a numeric port number or a service name. If the argument is omited the
 371 default port B<25826> is assumed.
 372
 373 =item B<TimeToLive> I<1-255>
 374
 375 Set the time-to-live of sent packets. This applies to all, unicast and
 376 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 377 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 378 operating systems.
 379
 380 =item B<Forward> I<true|false>
 381
 382 If set to I<true>, write packets that were received via the network plugin to
 383 the sending sockets. This should only be activated when the B<Listen>- and
 384 B<Server>-statements differ. Otherwise packets may be send multiple times to
 385 the same multicast group. While this results in more network traffic than
 386 neccessary it's not a huge problem since the plugin has a duplicate detection,
 387 so the values will not loop.
 388
 389 =item B<CacheFlush> I<Seconds>
 390
 391 For each host/plugin/type combination the C<network plugin> caches the time of
 392 the last value being sent or received. Every I<Seconds> seconds the plugin
 393 searches and removes all entries that are older than I<Seconds> seconds, thus
 394 freeing the unused memory again. Since this process is somewhat expensive and
 395 normally doesn't do much, this value should not be too small. The default is
 396 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
 397 either.
 398
 399 =back
 400
 401 =head2 Plugin C<ntpd>
 402
 403 =over 4
 404
 405 =item B<Host> I<Hostname>
 406
 407 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 408
 409 =item B<Port> I<Port>
 410
 411 UDP-Port to connect to. Defaults to B<123>.
 412
 413 =back
 414
 415 =head2 Plugin C<nut>
 416
 417 =over 4
 418
 419 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
 420
 421 Add a UPS to collect data from. The format is identical to the one accepted by
 422 L<upsc(8)>.
 423
 424 =back
 425
 426 =head2 Plugin C<ping>
 427
 428 =over 4
 429
 430 =item B<Host> I<IP-address>
 431
 432 Host to ping periodically. This option may be repeated several times to ping
 433 multiple hosts.
 434
 435 =item B<TTL> I<0-255>
 436
 437 Sets the Time-To-Live of generated ICMP packets.
 438
 439 =back
 440
 441 =head2 Plugin C<processes>
 442
 443 =over 4
 444
 445 =item B<Process> I<Name>
 446
 447 Select more detailed statistics of processes matching this name. The statistics
 448 collected for these selected processes are size of the resident segment size
 449 (RSS), user- and system-time used, number of processes and number of threads,
 450 and minor and major pagefaults.
 451
 452 =back
 453
 454 =head2 Plugin C<rrdtool>
 455
 456 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 457 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 458 using these settings. If you don't want to dive into the depths of RRDTool, you
 459 can savely ignore these settings.
 460
 461 =over 4
 462
 463 =item B<DataDir> I<Directory>
 464
 465 Set the directory to store CSV-files under. Per default CSV-files are generated
 466 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 467
 468 =item B<StepSize> I<Seconds>
 469
 470 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 471 setting is identical to the global B<Interval>-option and should not be
 472 smaller. If unsure, don't set this option.
 473
 474 =item B<HeartBeat> I<Seconds>
 475
 476 Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger
 477 than the B<Interval>-setting, by default it's twice the B<Interval>-setting. If
 478 unsure, don't set this option.
 479
 480 =item B<RRARows> I<NumRows>
 481
 482 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 483 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 484 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 485 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 486 week, one month, and one year.
 487
 488 So for each timespan, it calculates how many PDPs need to be consolidated into
 489 one CDP by calculating:
 490   number of PDPs = timespan / (stepsize * rrarows)
 491
 492 Bottom line is, set this no smaller than the width of you graphs in pixels. The
 493 default is 1200.
 494
 495 =item B<XFF> I<Factor>
 496
 497 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
 498
 499 =item B<CacheFlush> I<Seconds>
 500
 501 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 502 it writes all values for a certain RRD-file if the oldest value is older than
 503 (or equal to) the number of seconds specified. If some RRD-file is not updated
 504 anymore for some reason (the computer was shut down, the network is broken,
 505 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 506 entire cache is searched for entries older than B<CacheTimeout> seconds and
 507 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 508 does nothing under normal circumstances, this value should not be too small.
 509 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 510 normally do much harm either.
 511
 512 =item B<CacheTimeout> I<Seconds>
 513
 514 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 515 save values in a cache, as described above. Writing multiple values at once
 516 reduces IO-operations and thus lessens the load produced by updating the files.
 517 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 518 used.
 519
 520 =back
 521
 522 =head2 Plugin C<sensors>
 523
 524 =over 4
 525
 526 =item B<Sensor> I<chip-bus-address/type-feature>
 527
 528 Selects the name of the sensor which you want to collect or ignore, depending
 529 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 530 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 531 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 532
 533 =item B<IgnoreSelected> I<true>|I<false>
 534
 535 If no configuration if given, the B<sensors>-plugin will collect data from all
 536 sensors. This may not be practical, especially for uninteresting sensors.
 537 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 538 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
 539 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 540 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 541 and all other sensors are collected.
 542
 543 =back
 544
 545 =head2 Plugin C<syslog>
 546
 547 =over 4
 548
 549 =item B<LogLevel> B<debug|info|notice|warning|err>
 550
 551 Sets the log-level. If, for example, set to B<notice>, then all events with
 552 severity B<notice>, B<warning>, or B<err> will be submitted to the
 553 syslog-daemon.
 554
 555 =back
 556
 557 =head2 Plugin C<unixsock>
 558
 559 =over 4
 560
 561 =item B<SocketFile> I<Path>
 562
 563 Sets the socket-file which is to be created.
 564
 565 =item B<SocketGroup> I<Group>
 566
 567 If running as root change the group of the UNIX-socket after it has been
 568 created. Defaults to B<collectd>.
 569
 570 =item B<SocketPerms> I<Permissions>
 571
 572 Change the file permissions of the UNIX-socket after it has been created. The
 573 permissions must be given as a numeric, octal value as you would pass to
 574 L<chmod(1)>. Defaults to B<0770>.
 575
 576 =back
 577
 578 =head1 SEE ALSO
 579
 580 L<collectd(1)>
 581
 582 =head1 AUTHOR
 583
 584 Florian Forster E<lt>octo@verplant.orgE<gt>
 585
 586 =cut