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