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 famous
  28 B<Apache Webserver>. Each line contains 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 expression, 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 Plugins are loaded in the order listed in this config file. It is a good idea
  36 to load any logging plugins first in order to catch messages from plugins
  37 during configuration.
  38
  39 The configuration is read and processed in order, i.E<nbsp>e. from top to
  40 bottom. So the plugins are loaded in the order listed in this config file. It
  41 is a good idea to load any logging plugins first in order to catch messages
  42 from plugins during configuration. Also, the C<LoadPlugin> option B<must> occur
  43 B<before> the C<E<lt>Plugin ...E<gt>> block.
  44
  45 =head1 GLOBAL OPTIONS
  46
  47 =over 4
  48
  49 =item B<BaseDir> I<Directory>
  50
  51 Sets the base directory. This is the directory beneath all RRD-files are
  52 created. Possibly more subdirectories are created. This is also the working
  53 directory for the daemon.
  54
  55 =item B<LoadPlugin> I<Plugin>
  56
  57 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  58 will be mostly useless.
  59
  60 =item B<Include> I<File>
  61
  62 Includes the file I<File> as if it was copy and pasted here. To prevent loops
  63 and shooting yourself in the foot in interesting ways the nesting is limited to
  64 a depth of 8E<nbsp>levels, which should be sufficient for most uses.
  65
  66 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
  67 file, but you cannot include files from within blocks.
  68
  69 =item B<PIDFile> I<File>
  70
  71 Sets where to write the PID file to. This file is overwritten when it exists
  72 and deleted when the program is stopped. Some init-scripts might override this
  73 setting using the B<-P> command-line option.
  74
  75 =item B<PluginDir> I<Directory>
  76
  77 Path to the plugins (shared objects) of collectd.
  78
  79 =item B<TypesDB> I<File>
  80
  81 Set the file that contains the data-set descriptions.
  82
  83 =item B<Interval> I<Seconds>
  84
  85 Configures the interval in which to query the read plugins. Obviously smaller
  86 values lead to a higher system load produces by collectd, while higher values
  87 lead to more coarse statistics.
  88
  89 =item B<ReadThreads> I<Num>
  90
  91 Number of threads to start for reading plugins. The default value if B<5>, but
  92 you may want to increase this if you have more than five plugins that take a
  93 long time to read. Mostly those are plugin that do network-IO. Setting this to
  94 a value higher than the number of plugins you've loaded is totally useless.
  95
  96 =back
  97
  98 =head1 PLUGIN OPTIONS
  99
 100 Some plugins may register own options. These options must be enclosed in a
 101 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
 102 require external configuration, too. The C<apache plugin>, for example,
 103 required C<mod_status> to be configured in the webserver you're going to
 104 collect data from. These plugins are listed below as well, even if they don't
 105 require any configuration within collectd's configfile.
 106
 107 A list of all plugins and a short summary for each plugin can be found in the
 108 F<README> file shipped with the sourcecode and hopefully binary packets as
 109 well.
 110
 111 =head2 Plugin C<apache>
 112
 113 To configure the C<apache>-plugin you first need to configure the Apache
 114 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
 115 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
 116 the following snipped to base your Apache config upon:
 117
 118   ExtendedStatus on
 119   <IfModule mod_status.c>
 120     <Location /mod_status>
 121       SetHandler server-status
 122     </Location>
 123   </IfModule>
 124
 125 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
 126 also supported. It introduces a new field, called C<BusyServers>, to count the
 127 number of currently connected clients. This field is also supported.
 128
 129 The following options are accepted by the C<apache>-plugin:
 130
 131 =over 4
 132
 133 =item B<URL> I<http://host/mod_status?auto>
 134
 135 Sets the URL of the C<mod_status> output. This needs to be the output generated
 136 by C<ExtendedStatus on> and it needs to be the machine readable output
 137 generated by appending the C<?auto> argument.
 138
 139 =item B<User> I<Username>
 140
 141 Optional user name needed for authentication.
 142
 143 =item B<Password> I<Password>
 144
 145 Optional password needed for authentication.
 146
 147 =item B<CACert> I<File>
 148
 149 File that holds one or more SSL certificates. If you want to use HTTPS you will
 150 possibly need this option. What CA certificates come bundled with C<libcurl>
 151 and are checked by default depends on the distribution you use.
 152
 153 =back
 154
 155 =head2 Plugin C<apcups>
 156
 157 =over 4
 158
 159 =item B<Host> I<Hostname>
 160
 161 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 162 that IPv6 support has been disabled unless someone can confirm or decline that
 163 B<apcupsd> can handle it.
 164
 165 =item B<Port> I<Port>
 166
 167 TCP-Port to connect to. Defaults to B<3551>.
 168
 169 =back
 170
 171 =head2 Plugin C<cpufreq>
 172
 173 This plugin doesn't have any options. It reads
 174 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
 175 installed) to get the current CPU frequency. If this file does not exist make
 176 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
 177 installed and an "cpu governor" (that's a kernel module) is loaded.
 178
 179 =head2 Plugin C<csv>
 180
 181 =over 4
 182
 183 =item B<DataDir> I<Directory>
 184
 185 Set the directory to store CSV-files under. Per default CSV-files are generated
 186 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 187
 188 =back
 189
 190 =head2 Plugin C<df>
 191
 192 =over 4
 193
 194 =item B<Device> I<Device>
 195
 196 Select partitions based on the devicename.
 197
 198 =item B<MountPoint> I<Directory>
 199
 200 Select partitions based on the mountpoint.
 201
 202 =item B<FSType> I<FSType>
 203
 204 Select partitions based on the filesystem type.
 205
 206 =item B<IgnoreSelected> I<true>|I<false>
 207
 208 Invert the selection: If set to true, all partitions B<except> the ones that
 209 match any one of the criteria are collected. By default only selected
 210 partitions are collected if a selection is made. If no selection is configured
 211 at all, B<all> partitions are selected.
 212
 213 =back
 214
 215 =head2 Plugin C<dns>
 216
 217 =over 4
 218
 219 =item B<Interface> I<Interface>
 220
 221 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 222 option sets the interface that should be used. If this option is not set, or
 223 set to "any", the plugin will try to get packets from B<all> interfaces. This
 224 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 225
 226 =item B<IgnoreSource> I<IP-address>
 227
 228 Ignore packets that originate from this address.
 229
 230 =back
 231
 232 =head2 Plugin C<email>
 233
 234 =over 4
 235
 236 =item B<SocketFile> I<Path>
 237
 238 Sets the socket-file which is to be created.
 239
 240 =item B<SocketGroup> I<Group>
 241
 242 If running as root change the group of the UNIX-socket after it has been
 243 created. Defaults to B<collectd>.
 244
 245 =item B<SocketPerms> I<Permissions>
 246
 247 Change the file permissions of the UNIX-socket after it has been created. The
 248 permissions must be given as a numeric, octal value as you would pass to
 249 L<chmod(1)>. Defaults to B<0770>.
 250
 251 =item B<MaxConns> I<Number>
 252
 253 Sets the maximum number of connections that can be handled in parallel. Since
 254 this many threads will be started immediately setting this to a very high
 255 value will waste valuable resources. Defaults to B<5> and will be forced to be
 256 at most B<16384> to prevent typos and dumb mistakes.
 257
 258 =back
 259
 260 =head2 Plugin C<exec>
 261
 262 Please make sure to read L<collectd-exec(5)> before using this plugin. It
 263 contains valuable information on when the executable is executed and the
 264 output that is expected from it.
 265
 266 =over 4
 267
 268 =item B<Exec> I<User>[:[I<Group>]] I<Executable>
 269
 270 Execute the executable I<Executable> as user I<User>. If the user name is
 271 followed by a colon and a group name, the effective group is set to that group.
 272 The real group and saved-set group will be set to the default group of that
 273 user. If no group is given the effective group ID will be the same as the real
 274 group ID.
 275
 276 Please note that in order to change the user and/or group the daemon needs
 277 superuser privileges. If the daemon is run as an unprivileged user you must
 278 specify the same user/group here. If the daemon is run with superuser
 279 privileges, you must supply a non-root user here.
 280
 281 =back
 282
 283 =head2 Plugin C<hddtemp>
 284
 285 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
 286 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
 287 default values, see below. C<hddtemp> has to be running to work correctly. If
 288 C<hddtemp> is not running timeouts may appear which may interfere with other
 289 statistics..
 290
 291 The B<hddtemp> homepage can be found at
 292 L<http://www.guzu.net/linux/hddtemp.php>.
 293
 294 =over 4
 295
 296 =item B<Host> I<Hostname>
 297
 298 Hostname to connect to. Defaults to B<127.0.0.1>.
 299
 300 =item B<Port> I<Port>
 301
 302 TCP-Port to connect to. Defaults to B<7634>.
 303
 304 =back
 305
 306 =head2 Plugin C<interface>
 307
 308 =over 4
 309
 310 =item B<Interface> I<Interface>
 311
 312 Select this interface. By default these interfaces will then be collected. For
 313 a more detailed description see B<IgnoreSelected> below.
 314
 315 =item B<IgnoreSelected> I<true>|I<false>
 316
 317 If no configuration if given, the B<traffic>-plugin will collect data from
 318 all interfaces. This may not be practical, especially for loopback- and
 319 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 320 interfaces you're interested in. Sometimes, however, it's easier/preferred
 321 to collect all interfaces I<except> a few ones. This option enables you to
 322 do that: By setting B<IgnoreSelected> to I<true> the effect of
 323 B<Interface> is inversed: All selected interfaces are ignored and all
 324 other interfaces are collected.
 325
 326 =back
 327
 328 =head2 Plugin C<iptables>
 329
 330 =over 4
 331
 332 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
 333
 334 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
 335 will collect the counters of all rules which have a comment-match. The comment
 336 is then used as type-instance.
 337
 338 If I<Comment> or I<Number> is given, only the rule with the matching comment or
 339 the I<n>th rule will be collected. Again, the comment (or the number) will be
 340 used as the type-instance.
 341
 342 If I<Name> is supplied, it will be used as the type-instance instead of the
 343 comment or the number.
 344
 345 =back
 346
 347 =head2 Plugin C<irq>
 348
 349 =over 4
 350
 351 =item B<Irq> I<Irq>
 352
 353 Select this irq. By default these irqs will then be collected. For a more
 354 detailed description see B<IgnoreSelected> below.
 355
 356 =item B<IgnoreSelected> I<true>|I<false>
 357
 358 If no configuration if given, the B<irq>-plugin will collect data from all
 359 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 360 can use the B<Irq>-option to pick the interrupt you're interested in.
 361 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
 362 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 363 I<true> the effect of B<Irq> is inversed: All selected interrupts are ignored
 364 and all other interrupts are collected.
 365
 366 =back
 367
 368 =head2 Plugin C<logfile>
 369
 370 =over 4
 371
 372 =item B<LogLevel> B<debug|info|notice|warning|err>
 373
 374 Sets the log-level. If, for example, set to B<notice>, then all events with
 375 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
 376
 377 =item B<File> I<File>
 378
 379 Sets the file to write log messages to. The special strings B<stdout> and
 380 B<stderr> can be used to write to the standard output and standard error
 381 channels, respectively. This, of course, only makes much sense when collectd is
 382 running in foreground- or non-daemon-mode.
 383
 384 =item B<Timestamp> B<true>|B<false>
 385
 386 Prefix all lines printed by the current time. Defaults to B<true>.
 387
 388 =back
 389
 390 =head2 Plugin C<mbmon>
 391
 392 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
 393
 394 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
 395 B<Host> and B<Port> options can be used to change these values, see below.
 396 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
 397 timeouts may appear which may interfere with other statistics..
 398
 399 C<mbmon> must be run with the -r option ("print TAG and Value format");
 400 Debian's F</etc/init.d/mbmon> script already does this, other people
 401 will need to ensure that this is the case.
 402
 403 =over 4
 404
 405 =item B<Host> I<Hostname>
 406
 407 Hostname to connect to. Defaults to B<127.0.0.1>.
 408
 409 =item B<Port> I<Port>
 410
 411 TCP-Port to connect to. Defaults to B<411>.
 412
 413 =back
 414
 415 =head2 Plugin C<memcached>
 416
 417 The C<memcached plugin> connects to a memcached server and queries statistics
 418 about cache utilization, memory and bandwidth used.
 419 L<http://www.danga.com/memcached/>
 420
 421 =over 4
 422
 423 =item B<Host> I<Hostname>
 424
 425 Hostname to connect to. Defaults to B<127.0.0.1>.
 426
 427 =item B<Port> I<Port>
 428
 429 TCP-Port to connect to. Defaults to B<11211>.
 430
 431 =back
 432
 433 =head2 Plugin C<mysql>
 434
 435 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
 436 database when started and keeps the connection up as long as possible. When the
 437 connection is interrupted for whatever reason it will try to re-connect. The
 438 plugin will complaint loudly in case anything goes wrong.
 439
 440 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
 441 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
 442 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
 443 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
 444 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
 445 I<5.2.4. Server Status Variables> for an explanation of these values.
 446
 447 Use the following options to configure the plugin:
 448
 449 =over 4
 450
 451 =item B<Host> I<Hostname>
 452
 453 Hostname of the database server. Defaults to B<localhost>.
 454
 455 =item B<User> I<Username>
 456
 457 Username to use when connecting to the database.
 458
 459 =item B<Password> I<Password>
 460
 461 Password needed to log into the database.
 462
 463 =item B<Database> I<Database>
 464
 465 Select this database. Defaults to I<no database> which is a perfectly reasonable
 466 option for what this plugin does.
 467
 468 =back
 469
 470 =head2 Plugin C<netlink>
 471
 472 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
 473 statistics of various interface and routing aspects.
 474
 475 =over 4
 476
 477 =item B<Interface> I<Interface>
 478
 479 =item B<VerboseInterface> I<Interface>
 480
 481 Instruct the plugin to collect interface statistics. This is basically the same
 482 as the statistics provided by the C<interface> plugin (see above) but
 483 potentially much more detailed.
 484
 485 When configuring with B<Interface> only the basic statistics will be collected,
 486 namely octets, packets, and errors. These statistics are collected by
 487 the C<interface> plugin, too, so using both at the same time is no benefit.
 488
 489 When configured with B<VerboseInterface> all counters B<except> the basic ones,
 490 so that no data needs to be collected twice if you use the C<interface> plugin.
 491 This includes dropped packets, received multicast packets, collisions and a
 492 whole zoo of differentiated RX and TX errors. You can try the following command
 493 to get an idea of what awaits you:
 494
 495   ip -s -s link list
 496
 497 If I<Interface> is B<All>, all interfaces will be selected.
 498
 499 =item B<QDisc> I<Interface> [I<QDisc>]
 500
 501 =item B<Class> I<Interface> [I<Class>]
 502
 503 =item B<Filter> I<Interface> [I<Filter>]
 504
 505 Collect the octets and packets that pass a certain qdisc, class or filter.
 506
 507 QDiscs and classes are identified by their type and handle (or classid).
 508 Filters don't necessarily have a handle, therefore the parent's handle is used.
 509 The notation used in collectd differs from that used in tc(1) in that it
 510 doesn't skip the major or minor number if it's zero and doesn't print special
 511 ids by their name.  So, for example, a qdisc may be identified by
 512 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
 513 thus not displayed by tc(1).
 514
 515 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
 516 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
 517 associated with that interface will be collected.
 518
 519 Since a filter itself doesn't necessarily have a handle, the parent's handle is
 520 used. This may lead to problems when more than one filter is attached to a
 521 qdisc or class. This isn't nice, but we don't know how this could be done any
 522 better. If you have a idea, please don't hesitate to tell us.
 523
 524 As with the B<Interface> option you can specify B<All> as the interface,
 525 meaning all interfaces.
 526
 527 Here are some examples to help you understand the above text more easily:
 528
 529   <Plugin netlink>
 530     VerboseInterface "All"
 531     QDisc "eth0" "pfifo_fast-1:0"
 532     QDisc "ppp0"
 533     Class "ppp0" "htb-1:10"
 534     Filter "ppp0" "u32-1:0"
 535   </Plugin>
 536
 537 =item B<IgnoreSelected>
 538
 539 The behaviour is the same as with all other similar plugins: If nothing is
 540 selected at all, everything is collected. If some things are selected using the
 541 options described above, only these statistics are collected. If you set
 542 B<IgnoreSelected> to B<true>, this behavior is inversed, i.E<nbsp>e. the
 543 specified statistics will not be collected.
 544
 545 =back
 546
 547 =head2 Plugin C<network>
 548
 549 =over 4
 550
 551 =item B<Listen> I<Host> [I<Port>]
 552
 553 =item B<Server> I<Host> [I<Port>]
 554
 555 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 556 may occur multiple times to send each datagram to multiple destinations.
 557
 558 The B<Listen> statement sets the interfaces to bind to. When multiple
 559 statements are found the daemon will bind to multiple interfaces.
 560
 561 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 562 the argument is a multicast address the daemon will join that multicast group.
 563
 564 If no B<Listen> statement is found the server tries join both, the default IPv6
 565 multicast group and the default IPv4 multicast group. If no B<Server> statement
 566 is found the client will try to send data to the IPv6 multicast group first. If
 567 that fails the client will try the IPv4 multicast group.
 568
 569 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 570 multicast group is C<239.192.74.66>.
 571
 572 The optional I<Port> argument sets the port to use. It can either be given
 573 using a numeric port number or a service name. If the argument is omitted the
 574 default port B<25826> is assumed.
 575
 576 =item B<TimeToLive> I<1-255>
 577
 578 Set the time-to-live of sent packets. This applies to all, unicast and
 579 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 580 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 581 operating systems.
 582
 583 =item B<Forward> I<true|false>
 584
 585 If set to I<true>, write packets that were received via the network plugin to
 586 the sending sockets. This should only be activated when the B<Listen>- and
 587 B<Server>-statements differ. Otherwise packets may be send multiple times to
 588 the same multicast group. While this results in more network traffic than
 589 necessary it's not a huge problem since the plugin has a duplicate detection,
 590 so the values will not loop.
 591
 592 =item B<CacheFlush> I<Seconds>
 593
 594 For each host/plugin/type combination the C<network plugin> caches the time of
 595 the last value being sent or received. Every I<Seconds> seconds the plugin
 596 searches and removes all entries that are older than I<Seconds> seconds, thus
 597 freeing the unused memory again. Since this process is somewhat expensive and
 598 normally doesn't do much, this value should not be too small. The default is
 599 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
 600 either.
 601
 602 =back
 603
 604 =head2 Plugin C<nginx>
 605
 606 This plugin collects the number of connections and requests handled by the
 607 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
 608 queries the page provided by the C<ngx_http_stub_status_module> module, which
 609 isn't compiled by default. Please refer to
 610 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
 611 how to compile and configure nginx and this module.
 612
 613 The following options are accepted by the C<nginx plugin>:
 614
 615 =over 4
 616
 617 =item B<URL> I<http://host/nginx_status>
 618
 619 Sets the URL of the C<ngx_http_stub_status_module> output.
 620
 621 =item B<User> I<Username>
 622
 623 Optional user name needed for authentication.
 624
 625 =item B<Password> I<Password>
 626
 627 Optional password needed for authentication.
 628
 629 =item B<CACert> I<File>
 630
 631 File that holds one or more SSL certificates. If you want to use HTTPS you will
 632 possibly need this option. What CA certificates come bundled with C<libcurl>
 633 and are checked by default depends on the distribution you use.
 634
 635 =back
 636
 637 =head2 Plugin C<ntpd>
 638
 639 =over 4
 640
 641 =item B<Host> I<Hostname>
 642
 643 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 644
 645 =item B<Port> I<Port>
 646
 647 UDP-Port to connect to. Defaults to B<123>.
 648
 649 =back
 650
 651 =head2 Plugin C<nut>
 652
 653 =over 4
 654
 655 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
 656
 657 Add a UPS to collect data from. The format is identical to the one accepted by
 658 L<upsc(8)>.
 659
 660 =back
 661
 662 =head2 Plugin C<perl>
 663
 664 This plugin embeds a Perl-interpreter into collectd and provides an interface
 665 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
 666
 667 =head2 Plugin C<ping>
 668
 669 =over 4
 670
 671 =item B<Host> I<IP-address>
 672
 673 Host to ping periodically. This option may be repeated several times to ping
 674 multiple hosts.
 675
 676 =item B<TTL> I<0-255>
 677
 678 Sets the Time-To-Live of generated ICMP packets.
 679
 680 =back
 681
 682 =head2 Plugin C<processes>
 683
 684 =over 4
 685
 686 =item B<Process> I<Name>
 687
 688 Select more detailed statistics of processes matching this name. The statistics
 689 collected for these selected processes are size of the resident segment size
 690 (RSS), user- and system-time used, number of processes and number of threads,
 691 and minor and major pagefaults.
 692
 693 =back
 694
 695 =head2 Plugin C<rrdtool>
 696
 697 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 698 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 699 using these settings. If you don't want to dive into the depths of RRDTool, you
 700 can safely ignore these settings.
 701
 702 =over 4
 703
 704 =item B<DataDir> I<Directory>
 705
 706 Set the directory to store RRD-files under. Per default RRD-files are generated
 707 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 708
 709 =item B<StepSize> I<Seconds>
 710
 711 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
 712 this setting is unset and the stepsize is set to the interval in which the data
 713 is collected. Do not use this option unless you absolutely have to for some
 714 reason. Setting this option may cause problems with the C<snmp plugin>, the
 715 C<exec plugin> or when the daemon is set up to receive data from other hosts.
 716
 717 =item B<HeartBeat> I<Seconds>
 718
 719 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
 720 in which case the heartbeat is set to twice the B<StepSize> which should equal
 721 the interval in which data is collected. Do not set this option unless you have
 722 a very good reason to do so.
 723
 724 =item B<RRARows> I<NumRows>
 725
 726 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 727 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 728 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 729 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 730 week, one month, and one year.
 731
 732 So for each timespan, it calculates how many PDPs need to be consolidated into
 733 one CDP by calculating:
 734   number of PDPs = timespan / (stepsize * rrarows)
 735
 736 Bottom line is, set this no smaller than the width of you graphs in pixels. The
 737 default is 1200.
 738
 739 =item B<RRATimespan> I<Seconds>
 740
 741 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
 742 more then one RRA. If this option is never used, the built-in default of (3600,
 743 86400, 604800, 2678400, 31622400) is used.
 744
 745 For more information on how RRA-sizes are calculated see B<RRARows> above.
 746
 747 =item B<XFF> I<Factor>
 748
 749 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
 750
 751 =item B<CacheFlush> I<Seconds>
 752
 753 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 754 it writes all values for a certain RRD-file if the oldest value is older than
 755 (or equal to) the number of seconds specified. If some RRD-file is not updated
 756 anymore for some reason (the computer was shut down, the network is broken,
 757 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 758 entire cache is searched for entries older than B<CacheTimeout> seconds and
 759 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 760 does nothing under normal circumstances, this value should not be too small.
 761 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 762 normally do much harm either.
 763
 764 =item B<CacheTimeout> I<Seconds>
 765
 766 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 767 save values in a cache, as described above. Writing multiple values at once
 768 reduces IO-operations and thus lessens the load produced by updating the files.
 769 The trade off is that the graphs kind of "drag behind" and that more memory is
 770 used.
 771
 772 =back
 773
 774 =head2 Plugin C<sensors>
 775
 776 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
 777 that all the needed modules have to be loaded and lm_sensors has to be
 778 configured (most likely by editing F</etc/sensors.conf>. Read
 779 L<sensors.conf(5)> for details.
 780
 781 The B<lm_sensors> homepage can be found at
 782 L<http://secure.netroedge.com/~lm78/>.
 783
 784 =over 4
 785
 786 =item B<Sensor> I<chip-bus-address/type-feature>
 787
 788 Selects the name of the sensor which you want to collect or ignore, depending
 789 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 790 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 791 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 792
 793 =item B<IgnoreSelected> I<true>|I<false>
 794
 795 If no configuration if given, the B<sensors>-plugin will collect data from all
 796 sensors. This may not be practical, especially for uninteresting sensors.
 797 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 798 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
 799 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 800 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 801 and all other sensors are collected.
 802
 803 =back
 804
 805 =head2 Plugin C<snmp>
 806
 807 Since the configuration of the C<snmp plugin> is a little more complicated than
 808 other plugins, its documentation has been moved to an own manpage,
 809 L<collectd-snmp(5)>. Please see there for details.
 810
 811 =head2 Plugin C<syslog>
 812
 813 =over 4
 814
 815 =item B<LogLevel> B<debug|info|notice|warning|err>
 816
 817 Sets the log-level. If, for example, set to B<notice>, then all events with
 818 severity B<notice>, B<warning>, or B<err> will be submitted to the
 819 syslog-daemon.
 820
 821 =back
 822
 823 =head2 Plugin C<tcpconns>
 824
 825 The C<tcpconns plugin> counts the number of currently established TCP
 826 connections based on the local port and/or the remote port. Since there may be
 827 a lot of connections the default if to count all connections with a local port,
 828 for which a listening socket is opened. You can use the following options to
 829 fine-tune the ports you are interested in:
 830
 831 =over 4
 832
 833 =item B<ListeningPorts> I<true>|I<false>
 834
 835 If this option is set to I<true>, statistics for all local ports for which a
 836 listening socket exists are collected. The default depends on B<LocalPort> and
 837 B<RemotePort> (see below): If no port at all is specifically selected, the
 838 default is to collect listening ports. If specific ports (no matter if local or
 839 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
 840 the selected ports will be collected unless this option is set to I<true>
 841 specifically.
 842
 843 =item B<LocalPort> I<Port>
 844
 845 Count the connections to a specific local port. This can be used to see how
 846 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
 847 You have to specify the port in numeric form, so for the mailserver example
 848 you'd need to set B<25>.
 849
 850 =item B<RemotePort> I<Port>
 851
 852 Count the connections to a specific remote port. This is useful to see how
 853 much a remote service is used. This is most useful if you want to know how many
 854 connections a local service has opened to remote services, e.E<nbsp>g. how many
 855 connections a mail server or news server has to other mail or news servers, or
 856 how many connections a web proxy holds to web servers. You have to give the
 857 port in numeric form.
 858
 859 =back
 860
 861 =head2 Plugin C<unixsock>
 862
 863 =over 4
 864
 865 =item B<SocketFile> I<Path>
 866
 867 Sets the socket-file which is to be created.
 868
 869 =item B<SocketGroup> I<Group>
 870
 871 If running as root change the group of the UNIX-socket after it has been
 872 created. Defaults to B<collectd>.
 873
 874 =item B<SocketPerms> I<Permissions>
 875
 876 Change the file permissions of the UNIX-socket after it has been created. The
 877 permissions must be given as a numeric, octal value as you would pass to
 878 L<chmod(1)>. Defaults to B<0770>.
 879
 880 =back
 881
 882 =head2 Plugin C<vserver>
 883
 884 This plugin doesn't have any options. B<VServer> support is only available for
 885 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
 886 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
 887 need to apply the patches and compile your own kernel, which will then provide
 888 the F</proc/virtual> filesystem that is required by this plugin.
 889
 890 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
 891
 892 =head1 SEE ALSO
 893
 894 L<collectd(1)>,
 895 L<collectd-exec(5)>,
 896 L<collectd-perl(5)>,
 897 L<collectd-unixsock(5)>,
 898 L<hddtemp(8)>,
 899 L<kstat(3KSTAT)>,
 900 L<mbmon(1)>,
 901 L<rrdtool(1)>,
 902 L<sensors(1)>
 903
 904 =head1 AUTHOR
 905
 906 Florian Forster E<lt>octo@verplant.orgE<gt>
 907
 908 =cut