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<csv>
 134
 135 =over 4
 136
 137 =item B<DataDir> I<Directory>
 138
 139 Set the directory to store RRD-files under. Per default RRD-files are generated
 140 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 141
 142 =back
 143
 144 =head2 Plugin C<df>
 145
 146 =over 4
 147
 148 =item B<Device> I<Device>
 149
 150 Select partitions based on the devicename.
 151
 152 =item B<MountPoint> I<Directory>
 153
 154 Select partitions based on the mountpoint.
 155
 156 =item B<FSType> I<FSType>
 157
 158 Select partitions based on the filesystem type.
 159
 160 =item B<IgnoreSelected> I<true>|I<false>
 161
 162 Invert the selection: If set to true, all partitions B<except> the ones that
 163 match any one of the criteria are collected. By default only selected
 164 partitions are collected if a selection is made. If no selection is conifured
 165 at all, B<all> partitions are selected.
 166
 167 =back
 168
 169 =head2 Plugin C<dns>
 170
 171 =over 4
 172
 173 =item B<Interface> I<Interface>
 174
 175 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
 176 option sets the interface that should be used. If this option is not set, or
 177 set to "any", the plugin will try to get packets from B<all> interfaces. This
 178 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
 179
 180 =item B<IgnoreSource> I<IP-address>
 181
 182 Ignore packets that originate from this address.
 183
 184 =back
 185
 186 =head2 Plugin C<email>
 187
 188 =over 4
 189
 190 =item B<SocketGroup> I<Group>
 191
 192 If running as root change the group of the UNIX-socket after it has been
 193 created. Defaults to B<collectd>.
 194
 195 =item B<SocketPerms> I<Permissions>
 196
 197 Change the file permissions of the UNIX-socket after it has been created. The
 198 permissions must be given as a numeric, octal value as you would pass to
 199 L<chmod(1)>. Defaults to B<0770>.
 200
 201 =item B<MaxConns> I<Number>
 202
 203 Sets the maximum number of connections that can be handled in parallel. Since
 204 this many threads will be started immediately setting this to a very high
 205 value will waste valuable resources. Defaults to B<5> and will be forced to be
 206 at most B<16384> to prevent typos and dumb mistakes.
 207
 208 =back
 209
 210 =head2 Plugin C<hddtemp>
 211
 212 =over 4
 213
 214 =item B<Host> I<Hostname>
 215
 216 Hostname to connect to. Defaults to B<127.0.0.1>.
 217
 218 =item B<Port> I<Port>
 219
 220 TCP-Port to connect to. Defaults to B<7634>.
 221
 222 =back
 223
 224 =head2 Plugin C<irq>
 225
 226 =over 4
 227
 228 =item B<Irq> I<Irq>
 229
 230 Select this irq. By default these irqs will then be collected. For a more
 231 detailed description see B<IgnoreSelected> below.
 232
 233 =item B<IgnoreSelected> I<true>|I<false>
 234
 235 If no configuration if given, the B<irq>-plugin will collect data from all
 236 irqs. This may not be practical, especially if no interrupts happen. Thus, you
 237 can use the B<Irq>-option to pick the interupt you're interested in.
 238 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
 239 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 240 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
 241 and all other interupts are collected.
 242
 243 =back
 244
 245 =head2 Plugin C<mbmon>
 246
 247 =over 4
 248
 249 =item B<Host> I<Hostname>
 250
 251 Hostname to connect to. Defaults to B<127.0.0.1>.
 252
 253 =item B<Port> I<Port>
 254
 255 TCP-Port to connect to. Defaults to B<411>.
 256
 257 =back
 258
 259 =head2 Plugin C<mysql>
 260
 261 =over 4
 262
 263 =item B<Host> I<Hostname>
 264
 265 Hostname of the database server. Defaults to B<localhost>.
 266
 267 =item B<User> I<Username>
 268
 269 Username to use when connecting to the database.
 270
 271 =item B<Password> I<Password>
 272
 273 Password needed to log into the database.
 274
 275 =item B<Database> I<Database>
 276
 277 Select this database. Defaults to I<no database> which is a perfecly reasonable
 278 option for what this plugin does.
 279
 280 =back
 281
 282 =head2 Plugin C<network>
 283
 284 =over 4
 285
 286 =item B<Listen> I<Host> [I<Port>]
 287
 288 =item B<Server> I<Host> [I<Port>]
 289
 290 The B<Server> statement sets the server to send datagrams B<to>.  The statement
 291 may occur multiple times to send each datagram to multiple destinations.
 292
 293 The B<Listen> statement sets the interfaces to bind to. When multiple
 294 statements are found the daemon will bind to multiple interfaces.
 295
 296 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
 297 the argument is a multicast address the daemon will join that multicast group.
 298
 299 If no B<Listen> statement is found the server tries join both, the default IPv6
 300 multicast group and the default IPv4 multicast group. If no B<Server> statement
 301 is found the client will try to send data to the IPv6 multicast group first. If
 302 that failes the client will try the IPv4 multicast group.
 303
 304 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 305 multicast group is C<239.192.74.66>.
 306
 307 The optional I<Port> argument sets the port to use. It can either be given
 308 using a numeric port number or a service name. If the argument is omited the
 309 default port B<25826> is assumed.
 310
 311 =item B<TimeToLive> I<1-255>
 312
 313 Set the time-to-live of sent packets. This applies to all, unicast and
 314 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
 315 That means that multicast packets will be sent with a TTL of C<1> (one) on most
 316 operating systems.
 317
 318 =back
 319
 320 =head2 Plugin C<ntpd>
 321
 322 =over 4
 323
 324 =item B<Host> I<Hostname>
 325
 326 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
 327
 328 =item B<Port> I<Port>
 329
 330 UDP-Port to connect to. Defaults to B<123>.
 331
 332 =back
 333
 334 =head2 Plugin C<ping>
 335
 336 =over 4
 337
 338 =item B<Host> I<IP-address>
 339
 340 Host to ping periodically. This option may be repeated several times to ping
 341 multiple hosts.
 342
 343 =item B<TTL> I<0-255>
 344
 345 Sets the Time-To-Live of generated ICMP packets.
 346
 347 =back
 348
 349 =head2 Plugin C<rrdtool>
 350
 351 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
 352 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
 353 using these settings. If you don't want to dive into the depths of RRDTool, you
 354 can savely ignore these settings.
 355
 356 =over 4
 357
 358 =item B<DataDir> I<Directory>
 359
 360 Set the directory to store CSV-files under. Per default CSV-files are generated
 361 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
 362
 363 =item B<StepSize> I<Seconds>
 364
 365 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
 366 setting is identical to the global B<Interval>-option and should not be
 367 smaller. If unsure, don't set this option.
 368
 369 =item B<HeartBeat> I<Seconds>
 370
 371 Sets the heartbeat of newly created RRD-files. Ideally (and per default) this
 372 setting is bigger than the B<Interval>-setting. If unsure, don't set this
 373 option.
 374
 375 =item B<RRARows> I<NumRows>
 376
 377 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
 378 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
 379 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
 380 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
 381 week, one month, and one year.
 382
 383 So for each timespan, it calculates how many PDPs need to be consolidated into
 384 one CDP by calculating:
 385   number of PDPs = timespan / (stepsize * rrarows)
 386
 387 Bottom line is, set this no smaller than the width of you graphs in pixels.
 388
 389 =item B<XFF> I<Factor>
 390
 391 Set the "XFiles Factor". This is mostly interesting if you set B<StepSize>
 392 bigger than B<Interval>. If unsure, don't set this option.
 393
 394 =item B<CacheFlush> I<Seconds>
 395
 396 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
 397 it writes all values for a certain RRD-file if the oldest value is older than
 398 (or equal to) the number of seconds specified. If some RRD-file is not updated
 399 anymore for some reason (the computer was shut down, the network is broken,
 400 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
 401 entire cache is searched for entries older than B<CacheTimeout> seconds and
 402 written to disk every I<Seconds> seconds. Since this is kind of expensive and
 403 does nothing under normal circumstances, this value should not be too small.
 404 900 seconds might be a good value, though setting this to 7200 seconds doesn't
 405 normally do much harm either.
 406
 407 =item B<CacheTimeout> I<Seconds>
 408
 409 If this option is set to a value greater than zero, the C<rrdtool plugin> will
 410 save values in a cache, as described above. Writing multiple values at once
 411 reduces IO-operations and thus lessens the load produced by updating the files.
 412 The tradeoff is that the graphs kind of "drag behind" and that more memory is
 413 used.
 414
 415 =back
 416
 417 =head2 Plugin C<sensors>
 418
 419 =over 4
 420
 421 =item B<Sensor> I<chip-bus-address/type-feature>
 422
 423 Selects the name of the sensor which you want to collect or ignore, depending
 424 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
 425 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
 426 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
 427
 428 =item B<IgnoreSelected> I<true>|I<false>
 429
 430 If no configuration if given, the B<sensors>-plugin will collect data from all
 431 sensors. This may not be practical, especially for uninteresting sensors.
 432 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
 433 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
 434 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
 435 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
 436 and all other sensors are collected.
 437
 438 =back
 439
 440 =head2 Plugin C<traffic>
 441
 442 =over 4
 443
 444 =item B<Interface> I<Interface>
 445
 446 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
 447
 448 =item B<IgnoreSelected> I<true>|I<false>
 449
 450 If no configuration if given, the B<traffic>-plugin will collect data from
 451 all interfaces. This may not be practical, especially for loopback- and
 452 similar interfaces. Thus, you can use the B<Interface>-option to pick the
 453 interfaces you're interested in. Sometimes, however, it's easier/prefered
 454 to collect all interfaces I<except> a few ones. This option enables you to
 455 do that: By setting B<IgnoreSelected> to I<true> the effect of
 456 B<Interface> is inversed: All selected interfaces are ignored and all
 457 other interfaces are collected.
 458
 459 =back
 460
 461 =head1 SEE ALSO
 462
 463 L<collectd(1)>
 464
 465 =head1 AUTHOR
 466
 467 Florian Forster E<lt>octo@verplant.orgE<gt>
 468
 469 =cut