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