src/collectd.conf.pod

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