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   LogFile "/path/to/logfile/collectd.log"
  10   Server  "123.123.123.123" 12345
  11
  12   LoadPlugin cpu
  13   LoadPlugin load
  14   LoadPlugin ping
  15
  16   <Plugin ping>
  17     Host "example.org"
  18     Host "provider.net"
  19   </Plugin>
  20
  21 =head1 DESCRIPTION
  22
  23 This config file controls how the system statistics collection daemon
  24 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
  25 controls which plugins to load. These plugins ultimately define collectd's
  26 behavior.
  27
  28 The syntax of this config file is similar to the config file of the famos
  29 B<Apache Webserver>. Each line containes either a key-value-pair or a
  30 section-start or -end. Empty lines and everything after the hash-symbol `#' is
  31 ignored. Values are either string, enclosed in double-quotes,
  32 (floating-point-)numbers or a boolean extression, i.E<nbsp>e. either B<true> or
  33 B<false>. String containing of only alphanumeric characters and underscores do
  34 not need to be quoted.
  35
  36 =head1 GLOBAL OPTIONS
  37
  38 =over 4
  39
  40 =item B<BaseDir> I<Directory>
  41
  42 Sets the base directory. This is the directory beneath all RRD-files are
  43 created. Possibly more subdirectories are created. This is also the working
  44 directory for the daemon.
  45
  46 =item B<LoadPlugin> I<Plugin>
  47
  48 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
  49 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
  50
  51 =item B<PIDFile> I<File>
  52
  53 Sets where to write the PID file to. This file is overwritten when it exists
  54 and deleted when the program ist stopped. Some init-scripts might override this
  55 setting using the B<-P> commandline option.
  56
  57 =item B<LogFile> I<File>
  58
  59 Sets the file to write debugging output to. This is only used if compiled with
  60 debugging enabled. It's ignored otherwise.
  61
  62 =item B<Interval> I<Seconds>
  63
  64 Configures the interval in which to query the read plugins. Obviously smaller
  65 values lead to a higher system load produces by collectd, while higher values
  66 lead to more coarse statistics. Please note that changing this value may render
  67 your RRD-files unuseable, if you use the C<rrdtool plugin>. You have been
  68 warned.
  69
  70 =back
  71
  72 =head1 PLUGIN OPTIONS
  73
  74 Some Plugins may register own options. These options must be inclosed in a
  75 C<Plugin>-Section. Which options exist depends on the plugin used:
  76
  77 =head2 Plugin C<apache>
  78
  79 To configure the C<apache>-plugin you first need to configure the Apache
  80 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
  81 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
  82 the following snipped to base your Apache config upon:
  83
  84   ExtendedStatus on
  85   <IfModule mod_status.c>
  86     <Location /mod_status>
  87       SetHandler server-status
  88     </Location>
  89   </IfModule>
  90
  91 The following options are accepted by the C<apache>-plugin:
  92
  93 =over 4
  94
  95 =item B<URL> I<http://host/mod_status?auto>
  96
  97 Sets the URL of the C<mod_status> output. This needs to be the output generated
  98 by C<ExtendedStatus on> and it needs to be the machine readable output
  99 generated by appending the C<?auto> argument.
 100
 101 =item B<User> I<Username>
 102
 103 Optional user name needed for authentication.
 104
 105 =item B<Password> I<Password>
 106
 107 Optional password needed for authentication.
 108
 109 =item B<CACert> I<File>
 110
 111 File that holds one or more SSL certificates. If you want to use HTTPS you will
 112 possibly need this option. What CA certificates come bundeled with C<libcurl>
 113 and are checked by default depends on the distribution you use.
 114
 115 =back
 116
 117 =head2 Plugin C<apcups>
 118
 119 =over 4
 120
 121 =item B<Host> I<Hostname>
 122
 123 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
 124 that IPv6 support has been disabled unless someone can confirm or decline that
 125 B<apcupsd> can handle it.
 126
 127 =item B<Port> I<Port>
 128
 129 TCP-Port to connect to. Defaults to B<3551>.
 130
 131 =back
 132
 133 =head2 Plugin C<df>
 134
 135 =over 4
 136
 137 =item B<Device> I<Device>
 138
 139 Select partitions based on the devicename.
 140
 141 =item B<MountPoint> I<Directory>
 142
 143 Select partitions based on the mountpoint.
 144
 145 =item B<FSType> I<FSType>
 146
 147 Select partitions based on the filesystem type.
 148
 149 =item B<IgnoreSelected> I<true>|I<false>
 150
 151 Invert the selection: If set to true, all partitions B<except> the ones that
 152 match any one of the criteria are collected. By default only selected
 153 partitions are collected if a selection is made. If no selection is conifured
 154 at all, B<all> partitions are selected.
 155
 156 =back
 157
 158 =head2 Plugin C<dns>
 159
 160 =over 4
 161
 162 =item B<Interface> I<Interface>
 163
 164 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 165 option sets the interface that should be used. If this option is not set, or
 166 set to "any", the plugin will try to get packets from B<all> interfaces. This
 167 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 168
 169 =item B<IgnoreSource> I<IP-address>
 170
 171 Ignore packets that originate from this address.
 172
 173 =back
 174
 175 =head2 Plugin C<email>
 176
 177 =over 4
 178
 179 =item B<SocketGroup> I<Group>
 180
 181 If running as root change the group of the UNIX-socket after it has been
 182 created. Defaults to B<collectd>.
 183
 184 =item B<SocketPerms> I<Permissions>
 185
 186 Change the file permissions of the UNIX-socket after it has been created. The
 187 permissions must be given as a numeric, octal value as you would pass to
 188 L<chmod(1)>. Defaults to B<0770>.
 189
 190 =item B<MaxConns> I<Number>
 191
 192 Sets the maximum number of connections that can be handled in parallel. Since
 193 this many threads will be started immediately setting this to a very high
 194 value will waste valuable resources. Defaults to B<5> and will be forced to be
 195 at most B<16384> to prevent typos and dumb mistakes.
 196
 197 =back
 198
 199 =head2 Plugin C<hddtemp>
 200
 201 =over 4
 202
 203 =item B<Host> I<Hostname>
 204
 205 Hostname to connect to. Defaults to B<127.0.0.1>.
 206
 207 =item B<Port> I<Port>
 208
 209 TCP-Port to connect to. Defaults to B<7634>.
 210
 211 =back
 212
 213 =head2 Plugin C<irq>
 214
 215 =over 4
 216
 217 =item B<Irq> I<Irq>
 218
 219 Select this irq. By default these irqs will then be collected. For a more
 220 detailed description see B<IgnoreSelected> below.
 221
 222 =item B<IgnoreSelected> I<true>|I<false>
 223
 224 If no configuration if given, the B<irq>-plugin will collect data from all
 225 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 226 can use the B<Irq>-option to pick the interupt you're interested in.
 227 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 228 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 229 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 230 and all other interupts are collected.
 231
 232 =back
 233
 234 =head2 Plugin C<mbmon>
 235
 236 =over 4
 237
 238 =item B<Host> I<Hostname>
 239
 240 Hostname to connect to. Defaults to B<127.0.0.1>.
 241
 242 =item B<Port> I<Port>
 243
 244 TCP-Port to connect to. Defaults to B<411>.
 245
 246 =back
 247
 248 =head2 Plugin C<mysql>
 249
 250 =over 4
 251
 252 =item B<Host> I<Hostname>
 253
 254 Hostname of the database server. Defaults to B<localhost>.
 255
 256 =item B<User> I<Username>
 257
 258 Username to use when connecting to the database.
 259
 260 =item B<Password> I<Password>
 261
 262 Password needed to log into the database.
 263
 264 =item B<Database> I<Database>
 265
 266 Select this database. Defaults to I<no database> which is a perfecly reasonable
 267 option for what this plugin does.
 268
 269 =back
 270
 271 =head2 Plugin C<network>
 272
 273 =over 4
 274
 275 =item B<Listen> I<Host> [I<Port>]
 276
 277 =item B<Server> I<Host> [I<Port>]
 278
 279 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 280 may occur multiple times to send each datagram to multiple destinations.
 281
 282 The B<Listen> statement sets the interfaces to bind to. When multiple
 283 statements are found the daemon will bind to multiple interfaces.
 284
 285 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 286 the argument is a multicast address the daemon will join that multicast group.
 287
 288 If no B<Listen> statement is found the server tries join both, the default IPv6
 289 multicast group and the default IPv4 multicast group. If no B<Server> statement
 290 is found the client will try to send data to the IPv6 multicast group first. If
 291 that failes the client will try the IPv4 multicast group.
 292
 293 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 294 multicast group is C<239.192.74.66>.
 295
 296 The optional I<Port> argument sets the port to use. It can either be given
 297 using a numeric port number or a service name. If the argument is omited the
 298 default port B<25826> is assumed.
 299
 300 =item B<TimeToLive> I<1-255>
 301
 302 Set the time-to-live of sent packets. This applies to all, unicast and
 303 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 304 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 305 operating systems.
 306
 307 =back
 308
 309 =head2 Plugin C<ntpd>
 310
 311 =over 4
 312
 313 =item B<Host> I<Hostname>
 314
 315 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 316
 317 =item B<Port> I<Port>
 318
 319 UDP-Port to connect to. Defaults to B<123>.
 320
 321 =back
 322
 323 =head2 Plugin C<ping>
 324
 325 =over 4
 326
 327 =item B<Host> I<IP-address>
 328
 329 Host to ping periodically. This option may be repeated several times to ping
 330 multiple hosts.
 331
 332 =item B<TTL> I<0-255>
 333
 334 Sets the Time-To-Live of generated ICMP packets.
 335
 336 =back
 337
 338 =head2 Plugin C<rrdtool>
 339
 340 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 341 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 342 using these settings. If you don't want to dive into the depths of RRDTool, you
 343 can savely ignore these settings.
 344
 345 =over 4
 346
 347 =item B<DataDir> I<Directory>
 348
 349 Set the directory to store RRD-files under. Per default RRD-files are generated
 350 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 351
 352 =item B<StepSize> I<Seconds>
 353
 354 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 355 setting is identical to the global B<Interval>-option and should not be
 356 smaller. If unsure, don't set this option.
 357
 358 =item B<HeartBeat> I<Seconds>
 359
 360 Sets the heartbeat of newly created RRD-files. Ideally (and per default) this
 361 setting is bigger than the B<Interval>-setting. If unsure, don't set this
 362 option.
 363
 364 =item B<RRARows> I<NumRows>
 365
 366 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 367 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 368 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 369 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 370 week, one month, and one year.
 371
 372 So for each timespan, it calculates how many PDPs need to be consolidated into
 373 one CDP by calculating:
 374   number of PDPs = timespan / (stepsize * rrarows)
 375
 376 Bottom line is, set this no smaller than the width of you graphs in pixels.
 377
 378 =item B<XFF> I<Factor>
 379
 380 Set the "XFiles Factor". This is mostly interesting if you set B<StepSize>
 381 bigger than B<Interval>. If unsure, don't set this option.
 382
 383 =item B<CacheFlush> I<Seconds>
 384
 385 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 386 it writes all values for a certain RRD-file if the oldest value is older than
 387 (or equal to) the number of seconds specified. If some RRD-file is not updated
 388 anymore for some reason (the computer was shut down, the network is broken,
 389 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 390 entire cache is searched for entries older than B<CacheTimeout> seconds and
 391 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 392 does nothing under normal circumstances, this value should not be too small.
 393 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 394 normally do much harm either.
 395
 396 =item B<CacheTimeout> I<Seconds>
 397
 398 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 399 save values in a cache, as described above. Writing multiple values at once
 400 reduces IO-operations and thus lessens the load produced by updating the files.
 401 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 402 used.
 403
 404 =back
 405
 406 =head2 Plugin C<sensors>
 407
 408 =over 4
 409
 410 =item B<Sensor> I<chip-bus-address/type-feature>
 411
 412 Selects the name of the sensor which you want to collect or ignore, depending
 413 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 414 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 415 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 416
 417 =item B<IgnoreSelected> I<true>|I<false>
 418
 419 If no configuration if given, the B<sensors>-plugin will collect data from all
 420 sensors. This may not be practical, especially for uninteresting sensors.
 421 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 422 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
 423 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 424 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 425 and all other sensors are collected.
 426
 427 =back
 428
 429 =head2 Plugin C<traffic>
 430
 431 =over 4
 432
 433 =item B<Interface> I<Interface>
 434
 435 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
 436
 437 =item B<IgnoreSelected> I<true>|I<false>
 438
 439 If no configuration if given, the B<traffic>-plugin will collect data from
 440 all interfaces. This may not be practical, especially for loopback- and
 441 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 442 interfaces you're interested in. Sometimes, however, it's easier/prefered
 443 to collect all interfaces I<except> a few ones. This option enables you to
 444 do that: By setting B<IgnoreSelected> to I<true> the effect of
 445 B<Interface> is inversed: All selected interfaces are ignored and all
 446 other interfaces are collected.
 447
 448 =back
 449
 450 =head1 SEE ALSO
 451
 452 L<collectd(1)>
 453
 454 =head1 AUTHOR
 455
 456 Florian Forster E<lt>octo@verplant.orgE<gt>
 457
 458 =cut