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