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. The names of the plugins are listed in L<collectd(1)>.
  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<Interval> I<Seconds>
  57
  58 Configures the interval in which to query the read plugins. Obviously smaller
  59 values lead to a higher system load produces by collectd, while higher values
  60 lead to more coarse statistics.
  61
  62 =back
  63
  64 =head1 PLUGIN OPTIONS
  65
  66 Some Plugins may register own options. These options must be inclosed in a
  67 C<Plugin>-Section. Which options exist depends on the plugin used:
  68
  69 =head2 Plugin C<apache>
  70
  71 To configure the C<apache>-plugin you first need to configure the Apache
  72 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
  73 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
  74 the following snipped to base your Apache config upon:
  75
  76   ExtendedStatus on
  77   <IfModule mod_status.c>
  78     <Location /mod_status>
  79       SetHandler server-status
  80     </Location>
  81   </IfModule>
  82
  83 Since it's C<mod_status> module is very similar to Apache's, B<lighttpd> is
  84 also supported. It introduces a new field, called C<BusyServers>, to count the
  85 number of currently connected clients. This field is also supported.
  86
  87 The following options are accepted by the C<apache>-plugin:
  88
  89 =over 4
  90
  91 =item B<URL> I<http://host/mod_status?auto>
  92
  93 Sets the URL of the C<mod_status> output. This needs to be the output generated
  94 by C<ExtendedStatus on> and it needs to be the machine readable output
  95 generated by appending the C<?auto> argument.
  96
  97 =item B<User> I<Username>
  98
  99 Optional user name needed for authentication.
 100
 101 =item B<Password> I<Password>
 102
 103 Optional password needed for authentication.
 104
 105 =item B<CACert> I<File>
 106
 107 File that holds one or more SSL certificates. If you want to use HTTPS you will
 108 possibly need this option. What CA certificates come bundeled with C<libcurl>
 109 and are checked by default depends on the distribution you use.
 110
 111 =back
 112
 113 =head2 Plugin C<apcups>
 114
 115 =over 4
 116
 117 =item B<Host> I<Hostname>
 118
 119 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 120 that IPv6 support has been disabled unless someone can confirm or decline that
 121 B<apcupsd> can handle it.
 122
 123 =item B<Port> I<Port>
 124
 125 TCP-Port to connect to. Defaults to B<3551>.
 126
 127 =back
 128
 129 =head2 Plugin C<csv>
 130
 131 =over 4
 132
 133 =item B<DataDir> I<Directory>
 134
 135 Set the directory to store RRD-files under. Per default RRD-files are generated
 136 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 137
 138 =back
 139
 140 =head2 Plugin C<df>
 141
 142 =over 4
 143
 144 =item B<Device> I<Device>
 145
 146 Select partitions based on the devicename.
 147
 148 =item B<MountPoint> I<Directory>
 149
 150 Select partitions based on the mountpoint.
 151
 152 =item B<FSType> I<FSType>
 153
 154 Select partitions based on the filesystem type.
 155
 156 =item B<IgnoreSelected> I<true>|I<false>
 157
 158 Invert the selection: If set to true, all partitions B<except> the ones that
 159 match any one of the criteria are collected. By default only selected
 160 partitions are collected if a selection is made. If no selection is conifured
 161 at all, B<all> partitions are selected.
 162
 163 =back
 164
 165 =head2 Plugin C<dns>
 166
 167 =over 4
 168
 169 =item B<Interface> I<Interface>
 170
 171 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 172 option sets the interface that should be used. If this option is not set, or
 173 set to "any", the plugin will try to get packets from B<all> interfaces. This
 174 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 175
 176 =item B<IgnoreSource> I<IP-address>
 177
 178 Ignore packets that originate from this address.
 179
 180 =back
 181
 182 =head2 Plugin C<email>
 183
 184 =over 4
 185
 186 =item B<SocketGroup> I<Group>
 187
 188 If running as root change the group of the UNIX-socket after it has been
 189 created. Defaults to B<collectd>.
 190
 191 =item B<SocketPerms> I<Permissions>
 192
 193 Change the file permissions of the UNIX-socket after it has been created. The
 194 permissions must be given as a numeric, octal value as you would pass to
 195 L<chmod(1)>. Defaults to B<0770>.
 196
 197 =item B<MaxConns> I<Number>
 198
 199 Sets the maximum number of connections that can be handled in parallel. Since
 200 this many threads will be started immediately setting this to a very high
 201 value will waste valuable resources. Defaults to B<5> and will be forced to be
 202 at most B<16384> to prevent typos and dumb mistakes.
 203
 204 =back
 205
 206 =head2 Plugin C<hddtemp>
 207
 208 =over 4
 209
 210 =item B<Host> I<Hostname>
 211
 212 Hostname to connect to. Defaults to B<127.0.0.1>.
 213
 214 =item B<Port> I<Port>
 215
 216 TCP-Port to connect to. Defaults to B<7634>.
 217
 218 =back
 219
 220 =head2 Plugin C<interface>
 221
 222 =over 4
 223
 224 =item B<Interface> I<Interface>
 225
 226 Select this interface. By default these interfaces will then be collected. For
 227 a more detailed description see B<IgnoreSelected> below.
 228
 229 =item B<IgnoreSelected> I<true>|I<false>
 230
 231 If no configuration if given, the B<traffic>-plugin will collect data from
 232 all interfaces. This may not be practical, especially for loopback- and
 233 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 234 interfaces you're interested in. Sometimes, however, it's easier/prefered
 235 to collect all interfaces I<except> a few ones. This option enables you to
 236 do that: By setting B<IgnoreSelected> to I<true> the effect of
 237 B<Interface> is inversed: All selected interfaces are ignored and all
 238 other interfaces are collected.
 239
 240 =back
 241
 242 =head2 Plugin C<iptables>
 243
 244 =over 4
 245
 246 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
 247
 248 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
 249 will collect the counters of all rules which have a comment-match. The comment
 250 is then used as type-instance.
 251
 252 If I<Comment> or I<Number> is given, only the rule with the matching comment or
 253 the I<n>th rule will be collected. Again, the comment (or the number) will be
 254 used as the type-instance.
 255
 256 If I<Name> is supplied, it will be used as the type-instance instead of the
 257 comment or the number.
 258
 259 =back
 260
 261 =head2 Plugin C<irq>
 262
 263 =over 4
 264
 265 =item B<Irq> I<Irq>
 266
 267 Select this irq. By default these irqs will then be collected. For a more
 268 detailed description see B<IgnoreSelected> below.
 269
 270 =item B<IgnoreSelected> I<true>|I<false>
 271
 272 If no configuration if given, the B<irq>-plugin will collect data from all
 273 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 274 can use the B<Irq>-option to pick the interupt you're interested in.
 275 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 276 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 277 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 278 and all other interupts are collected.
 279
 280 =back
 281
 282 =head2 Plugin C<logfile>
 283
 284 =over 4
 285
 286 =item B<LogLevel> B<debug|info|notice|warning|err>
 287
 288 Sets the log-level. If, for example, set to B<notice>, then all events with
 289 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
 290
 291 =item B<File> I<File>
 292
 293 Sets the file to write log messages to. The special strings B<stdout> and
 294 B<stderr> can be used to write to the standard output and standard error
 295 channels, respectively. This, of course, only makes much sense when collectd is
 296 running in foreground- or non-daemon-mode.
 297
 298 =back
 299
 300 =head2 Plugin C<mbmon>
 301
 302 =over 4
 303
 304 =item B<Host> I<Hostname>
 305
 306 Hostname to connect to. Defaults to B<127.0.0.1>.
 307
 308 =item B<Port> I<Port>
 309
 310 TCP-Port to connect to. Defaults to B<411>.
 311
 312 =back
 313
 314 =head2 Plugin C<mysql>
 315
 316 =over 4
 317
 318 =item B<Host> I<Hostname>
 319
 320 Hostname of the database server. Defaults to B<localhost>.
 321
 322 =item B<User> I<Username>
 323
 324 Username to use when connecting to the database.
 325
 326 =item B<Password> I<Password>
 327
 328 Password needed to log into the database.
 329
 330 =item B<Database> I<Database>
 331
 332 Select this database. Defaults to I<no database> which is a perfecly reasonable
 333 option for what this plugin does.
 334
 335 =back
 336
 337 =head2 Plugin C<network>
 338
 339 =over 4
 340
 341 =item B<Listen> I<Host> [I<Port>]
 342
 343 =item B<Server> I<Host> [I<Port>]
 344
 345 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 346 may occur multiple times to send each datagram to multiple destinations.
 347
 348 The B<Listen> statement sets the interfaces to bind to. When multiple
 349 statements are found the daemon will bind to multiple interfaces.
 350
 351 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 352 the argument is a multicast address the daemon will join that multicast group.
 353
 354 If no B<Listen> statement is found the server tries join both, the default IPv6
 355 multicast group and the default IPv4 multicast group. If no B<Server> statement
 356 is found the client will try to send data to the IPv6 multicast group first. If
 357 that failes the client will try the IPv4 multicast group.
 358
 359 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 360 multicast group is C<239.192.74.66>.
 361
 362 The optional I<Port> argument sets the port to use. It can either be given
 363 using a numeric port number or a service name. If the argument is omited the
 364 default port B<25826> is assumed.
 365
 366 =item B<TimeToLive> I<1-255>
 367
 368 Set the time-to-live of sent packets. This applies to all, unicast and
 369 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 370 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 371 operating systems.
 372
 373 =item B<Forward> I<true|false>
 374
 375 If set to I<true>, write packets that were received via the network plugin to
 376 the sending sockets. This should only be activated when the B<Listen>- and
 377 B<Server>-statements differ. Otherwise packets may be send multiple times to
 378 the same multicast group. While this results in more network traffic than
 379 neccessary it's not a huge problem since the plugin has a duplicate detection,
 380 so the values will not loop.
 381
 382 =back
 383
 384 =head2 Plugin C<ntpd>
 385
 386 =over 4
 387
 388 =item B<Host> I<Hostname>
 389
 390 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 391
 392 =item B<Port> I<Port>
 393
 394 UDP-Port to connect to. Defaults to B<123>.
 395
 396 =back
 397
 398 =head2 Plugin C<ping>
 399
 400 =over 4
 401
 402 =item B<Host> I<IP-address>
 403
 404 Host to ping periodically. This option may be repeated several times to ping
 405 multiple hosts.
 406
 407 =item B<TTL> I<0-255>
 408
 409 Sets the Time-To-Live of generated ICMP packets.
 410
 411 =back
 412
 413 =head2 Plugin C<processes>
 414
 415 =over 4
 416
 417 =item B<Process> I<Name>
 418
 419 Select more detailed statistics of processes matching this name. The statistics
 420 collected for these selected processes are size of the resident segment size
 421 (RSS), user- and system-time used, number of processes and number of threads,
 422 and minor and major pagefaults.
 423
 424 =back
 425
 426 =head2 Plugin C<rrdtool>
 427
 428 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 429 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 430 using these settings. If you don't want to dive into the depths of RRDTool, you
 431 can savely ignore these settings.
 432
 433 =over 4
 434
 435 =item B<DataDir> I<Directory>
 436
 437 Set the directory to store CSV-files under. Per default CSV-files are generated
 438 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 439
 440 =item B<StepSize> I<Seconds>
 441
 442 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 443 setting is identical to the global B<Interval>-option and should not be
 444 smaller. If unsure, don't set this option.
 445
 446 =item B<HeartBeat> I<Seconds>
 447
 448 Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger
 449 than the B<Interval>-setting, by default it's twice the B<Interval>-setting. If
 450 unsure, don't set this option.
 451
 452 =item B<RRARows> I<NumRows>
 453
 454 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 455 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 456 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 457 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 458 week, one month, and one year.
 459
 460 So for each timespan, it calculates how many PDPs need to be consolidated into
 461 one CDP by calculating:
 462   number of PDPs = timespan / (stepsize * rrarows)
 463
 464 Bottom line is, set this no smaller than the width of you graphs in pixels. The
 465 default is 1200.
 466
 467 =item B<XFF> I<Factor>
 468
 469 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
 470
 471 =item B<CacheFlush> I<Seconds>
 472
 473 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 474 it writes all values for a certain RRD-file if the oldest value is older than
 475 (or equal to) the number of seconds specified. If some RRD-file is not updated
 476 anymore for some reason (the computer was shut down, the network is broken,
 477 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 478 entire cache is searched for entries older than B<CacheTimeout> seconds and
 479 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 480 does nothing under normal circumstances, this value should not be too small.
 481 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 482 normally do much harm either.
 483
 484 =item B<CacheTimeout> I<Seconds>
 485
 486 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 487 save values in a cache, as described above. Writing multiple values at once
 488 reduces IO-operations and thus lessens the load produced by updating the files.
 489 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 490 used.
 491
 492 =back
 493
 494 =head2 Plugin C<sensors>
 495
 496 =over 4
 497
 498 =item B<Sensor> I<chip-bus-address/type-feature>
 499
 500 Selects the name of the sensor which you want to collect or ignore, depending
 501 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 502 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 503 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 504
 505 =item B<IgnoreSelected> I<true>|I<false>
 506
 507 If no configuration if given, the B<sensors>-plugin will collect data from all
 508 sensors. This may not be practical, especially for uninteresting sensors.
 509 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 510 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
 511 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 512 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 513 and all other sensors are collected.
 514
 515 =back
 516
 517 =head2 Plugin C<syslog>
 518
 519 =over 4
 520
 521 =item B<LogLevel> B<debug|info|notice|warning|err>
 522
 523 Sets the log-level. If, for example, set to B<notice>, then all events with
 524 severity B<notice>, B<warning>, or B<err> will be submitted to the
 525 syslog-daemon.
 526
 527 =back
 528
 529 =head2 Plugin C<unixsock>
 530
 531 =over 4
 532
 533 =item B<SocketFile> I<Path>
 534
 535 Sets the socket-file which is to be created.
 536
 537 =item B<SocketGroup> I<Group>
 538
 539 If running as root change the group of the UNIX-socket after it has been
 540 created. Defaults to B<collectd>.
 541
 542 =item B<SocketPerms> I<Permissions>
 543
 544 Change the file permissions of the UNIX-socket after it has been created. The
 545 permissions must be given as a numeric, octal value as you would pass to
 546 L<chmod(1)>. Defaults to B<0770>.
 547
 548 =back
 549
 550 =head1 SEE ALSO
 551
 552 L<collectd(1)>
 553
 554 =head1 AUTHOR
 555
 556 Florian Forster E<lt>octo@verplant.orgE<gt>
 557
 558 =cut