collectd.conf(5): Moved information about ``special'' plugins from collectd(1) to...
[collectd.git] / 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. Some plugins
83 require external configuration, too. The C<apache plugin>, for example,
84 required C<mod_status> to be configured in the webserver you're going to
85 collect data from. These plugins are listed below as well, even if they don't
86 require any configuration within collectd's configfile.
87
88 =head2 Plugin C<apache>
89
90 To configure the C<apache>-plugin you first need to configure the Apache
91 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
92 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
93 the following snipped to base your Apache config upon:
94
95   ExtendedStatus on
96   <IfModule mod_status.c>
97     <Location /mod_status>
98       SetHandler server-status
99     </Location>
100   </IfModule>
101
102 Since it's C<mod_status> module is very similar to Apache's, B<lighttpd> is
103 also supported. It introduces a new field, called C<BusyServers>, to count the
104 number of currently connected clients. This field is also supported.
105
106 The following options are accepted by the C<apache>-plugin:
107
108 =over 4
109
110 =item B<URL> I<http://host/mod_status?auto>
111
112 Sets the URL of the C<mod_status> output. This needs to be the output generated
113 by C<ExtendedStatus on> and it needs to be the machine readable output
114 generated by appending the C<?auto> argument.
115
116 =item B<User> I<Username>
117
118 Optional user name needed for authentication.
119
120 =item B<Password> I<Password>
121
122 Optional password needed for authentication.
123
124 =item B<CACert> I<File>
125
126 File that holds one or more SSL certificates. If you want to use HTTPS you will
127 possibly need this option. What CA certificates come bundeled with C<libcurl>
128 and are checked by default depends on the distribution you use.
129
130 =back
131
132 =head2 Plugin C<apcups>
133
134 =over 4
135
136 =item B<Host> I<Hostname>
137
138 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
139 that IPv6 support has been disabled unless someone can confirm or decline that
140 B<apcupsd> can handle it.
141
142 =item B<Port> I<Port>
143
144 TCP-Port to connect to. Defaults to B<3551>.
145
146 =back
147
148 =head2 Plugin C<cpufreq>
149
150 This plugin doesn't have any options. It reads
151 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
152 installed) to get the current CPU frequency. If this file does not exist make
153 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
154 installed and an "cpu governor" (that's a kernel module) is loaded.
155
156 =head2 Plugin C<csv>
157
158 =over 4
159
160 =item B<DataDir> I<Directory>
161
162 Set the directory to store RRD-files under. Per default RRD-files are generated
163 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
164
165 =back
166
167 =head2 Plugin C<df>
168
169 =over 4
170
171 =item B<Device> I<Device>
172
173 Select partitions based on the devicename.
174
175 =item B<MountPoint> I<Directory>
176
177 Select partitions based on the mountpoint.
178
179 =item B<FSType> I<FSType>
180
181 Select partitions based on the filesystem type.
182
183 =item B<IgnoreSelected> I<true>|I<false>
184
185 Invert the selection: If set to true, all partitions B<except> the ones that
186 match any one of the criteria are collected. By default only selected
187 partitions are collected if a selection is made. If no selection is conifured
188 at all, B<all> partitions are selected.
189
190 =back
191
192 =head2 Plugin C<dns>
193
194 =over 4
195
196 =item B<Interface> I<Interface>
197
198 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
199 option sets the interface that should be used. If this option is not set, or
200 set to "any", the plugin will try to get packets from B<all> interfaces. This
201 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
202
203 =item B<IgnoreSource> I<IP-address>
204
205 Ignore packets that originate from this address.
206
207 =back
208
209 =head2 Plugin C<email>
210
211 =over 4
212
213 =item B<SocketGroup> I<Group>
214
215 If running as root change the group of the UNIX-socket after it has been 
216 created. Defaults to B<collectd>.
217
218 =item B<SocketPerms> I<Permissions>
219
220 Change the file permissions of the UNIX-socket after it has been created. The
221 permissions must be given as a numeric, octal value as you would pass to
222 L<chmod(1)>. Defaults to B<0770>.
223
224 =item B<MaxConns> I<Number>
225
226 Sets the maximum number of connections that can be handled in parallel. Since
227 this many threads will be started immediately setting this to a very high
228 value will waste valuable resources. Defaults to B<5> and will be forced to be
229 at most B<16384> to prevent typos and dumb mistakes.
230
231 =back
232
233 =head2 Plugin C<exec>
234
235 Please make sure to read L<collectd-exec(5)> before using this plugin. It
236 contains valueable information on when the executable is executed and the
237 output that is expected from it.
238
239 =over 4
240
241 =item B<Exec> I<User> I<Executable>
242
243 Execute the executable I<Executable> as user I<User>.
244
245 =back
246
247 =head2 Plugin C<hddtemp>
248
249 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
250 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
251 default values, see below. C<hddtemp> has to be running to work correctly. If
252 C<hddtemp> is not running timeouts may appear which may interfere with other
253 statistics..
254
255 The B<hddtemp> homepage can be found at
256 L<http://www.guzu.net/linux/hddtemp.php>.
257
258 =over 4
259
260 =item B<Host> I<Hostname>
261
262 Hostname to connect to. Defaults to B<127.0.0.1>.
263
264 =item B<Port> I<Port>
265
266 TCP-Port to connect to. Defaults to B<7634>.
267
268 =back
269
270 =head2 Plugin C<interface>
271
272 =over 4
273
274 =item B<Interface> I<Interface>
275
276 Select this interface. By default these interfaces will then be collected. For
277 a more detailed description see B<IgnoreSelected> below.
278
279 =item B<IgnoreSelected> I<true>|I<false>
280
281 If no configuration if given, the B<traffic>-plugin will collect data from
282 all interfaces. This may not be practical, especially for loopback- and
283 similar interfaces. Thus, you can use the B<Interface>-option to pick the
284 interfaces you're interested in. Sometimes, however, it's easier/prefered
285 to collect all interfaces I<except> a few ones. This option enables you to
286 do that: By setting B<IgnoreSelected> to I<true> the effect of
287 B<Interface> is inversed: All selected interfaces are ignored and all
288 other interfaces are collected.
289
290 =back
291
292 =head2 Plugin C<iptables>
293
294 =over 4
295
296 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
297
298 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
299 will collect the counters of all rules which have a comment-match. The comment
300 is then used as type-instance.
301
302 If I<Comment> or I<Number> is given, only the rule with the matching comment or
303 the I<n>th rule will be collected. Again, the comment (or the number) will be
304 used as the type-instance.
305
306 If I<Name> is supplied, it will be used as the type-instance instead of the
307 comment or the number.
308
309 =back
310
311 =head2 Plugin C<irq>
312
313 =over 4
314
315 =item B<Irq> I<Irq>
316
317 Select this irq. By default these irqs will then be collected. For a more
318 detailed description see B<IgnoreSelected> below.
319
320 =item B<IgnoreSelected> I<true>|I<false>
321
322 If no configuration if given, the B<irq>-plugin will collect data from all
323 irqs. This may not be practical, especially if no interrupts happen. Thus, you
324 can use the B<Irq>-option to pick the interupt you're interested in.
325 Sometimes, however, it's easier/prefered to collect all interupts I<except> a
326 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
327 I<true> the effect of B<Irq> is inversed: All selected interupts are ignored
328 and all other interupts are collected.
329
330 =back
331
332 =head2 Plugin C<logfile>
333
334 =over 4
335
336 =item B<LogLevel> B<debug|info|notice|warning|err>
337
338 Sets the log-level. If, for example, set to B<notice>, then all events with
339 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
340
341 =item B<File> I<File>
342
343 Sets the file to write log messages to. The special strings B<stdout> and
344 B<stderr> can be used to write to the standard output and standard error
345 channels, respectively. This, of course, only makes much sense when collectd is
346 running in foreground- or non-daemon-mode.
347
348 =back
349
350 =head2 Plugin C<mbmon>
351
352 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
353
354 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.  The
355 B<Host> and B<Port> options can be used to change these values, see below.
356 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
357 timeouts may appear which may interfere with other statistics..
358
359 C<mbmon> must be run with the -r option ("print TAG and Value format");
360 Debian's F</etc/init.d/mbmon> script already does this, other people
361 will need to ensure that this is the case.
362
363 =over 4
364
365 =item B<Host> I<Hostname>
366
367 Hostname to connect to. Defaults to B<127.0.0.1>.
368
369 =item B<Port> I<Port>
370
371 TCP-Port to connect to. Defaults to B<411>.
372
373 =back
374
375 =head2 Plugin C<mysql>
376
377 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
378 database when started and keeps the connection up as long as possible. When the
379 connection is interrupted for whatever reason it will try to re-connect. The
380 plugin logs loud complaints in case anything goes wrong.
381
382 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
383 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
384 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
385 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
386 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
387 I<5.2.4. Server Status Variables> for an explanation of these values.
388
389 Use the following options to configure the plugin:
390
391 =over 4
392
393 =item B<Host> I<Hostname>
394
395 Hostname of the database server. Defaults to B<localhost>.
396
397 =item B<User> I<Username>
398
399 Username to use when connecting to the database.
400
401 =item B<Password> I<Password>
402
403 Password needed to log into the database.
404
405 =item B<Database> I<Database>
406
407 Select this database. Defaults to I<no database> which is a perfecly reasonable
408 option for what this plugin does.
409
410 =back
411
412 =head2 Plugin C<network>
413
414 =over 4
415
416 =item B<Listen> I<Host> [I<Port>]
417
418 =item B<Server> I<Host> [I<Port>]
419
420 The B<Server> statement sets the server to send datagrams B<to>.  The statement
421 may occur multiple times to send each datagram to multiple destinations.
422
423 The B<Listen> statement sets the interfaces to bind to. When multiple
424 statements are found the daemon will bind to multiple interfaces.
425
426 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
427 the argument is a multicast address the daemon will join that multicast group.
428
429 If no B<Listen> statement is found the server tries join both, the default IPv6
430 multicast group and the default IPv4 multicast group. If no B<Server> statement
431 is found the client will try to send data to the IPv6 multicast group first. If
432 that failes the client will try the IPv4 multicast group.
433
434 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
435 multicast group is C<239.192.74.66>.
436
437 The optional I<Port> argument sets the port to use. It can either be given
438 using a numeric port number or a service name. If the argument is omited the
439 default port B<25826> is assumed.
440
441 =item B<TimeToLive> I<1-255>
442
443 Set the time-to-live of sent packets. This applies to all, unicast and
444 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
445 That means that multicast packets will be sent with a TTL of C<1> (one) on most
446 operating systems.
447
448 =item B<Forward> I<true|false>
449
450 If set to I<true>, write packets that were received via the network plugin to
451 the sending sockets. This should only be activated when the B<Listen>- and
452 B<Server>-statements differ. Otherwise packets may be send multiple times to
453 the same multicast group. While this results in more network traffic than
454 neccessary it's not a huge problem since the plugin has a duplicate detection,
455 so the values will not loop.
456
457 =item B<CacheFlush> I<Seconds>
458
459 For each host/plugin/type combination the C<network plugin> caches the time of
460 the last value being sent or received. Every I<Seconds> seconds the plugin
461 searches and removes all entries that are older than I<Seconds> seconds, thus
462 freeing the unused memory again. Since this process is somewhat expensive and
463 normally doesn't do much, this value should not be too small. The default is
464 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
465 either.
466
467 =back
468
469 =head2 Plugin C<ntpd>
470
471 =over 4
472
473 =item B<Host> I<Hostname>
474
475 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
476
477 =item B<Port> I<Port>
478
479 UDP-Port to connect to. Defaults to B<123>.
480
481 =back
482
483 =head2 Plugin C<nut>
484
485 =over 4
486
487 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
488
489 Add a UPS to collect data from. The format is identical to the one accepted by
490 L<upsc(8)>.
491
492 =back
493
494 =head2 Plugin C<perl>
495
496 =over 4
497
498 =item B<LoadPlugin> I<Plugin>
499
500 Loads the Perl plugin I<Plugin>. This does basically the same as B<use> would
501 do in a Perl program.
502
503 =item B<BaseName> I<Name>
504
505 Prepends I<Name>B<::> to all plugin names loaded after this option. This is
506 provided for convenience to keep plugin names short.
507
508 =item B<IncludeDir> I<Dir>
509
510 Adds I<Dir> to the B<@INC> array. This is the same as using the B<-IDir>
511 command line option or B<use lib Dir> in the source code.
512
513 =back
514
515 =head2 Plugin C<ping>
516
517 =over 4
518
519 =item B<Host> I<IP-address>
520
521 Host to ping periodically. This option may be repeated several times to ping
522 multiple hosts.
523
524 =item B<TTL> I<0-255>
525
526 Sets the Time-To-Live of generated ICMP packets.
527
528 =back
529
530 =head2 Plugin C<processes>
531
532 =over 4
533
534 =item B<Process> I<Name>
535
536 Select more detailed statistics of processes matching this name. The statistics
537 collected for these selected processes are size of the resident segment size
538 (RSS), user- and system-time used, number of processes and number of threads,
539 and minor and major pagefaults.
540
541 =back
542
543 =head2 Plugin C<rrdtool>
544
545 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
546 finetune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
547 using these settings. If you don't want to dive into the depths of RRDTool, you
548 can savely ignore these settings.
549
550 =over 4
551
552 =item B<DataDir> I<Directory>
553
554 Set the directory to store CSV-files under. Per default CSV-files are generated
555 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
556
557 =item B<StepSize> I<Seconds>
558
559 Sets the stepsize of newly created RRD-files. Ideally (and per default) this
560 setting is identical to the global B<Interval>-option and should not be
561 smaller. If unsure, don't set this option.
562
563 =item B<HeartBeat> I<Seconds>
564
565 Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger
566 than the B<Interval>-setting, by default it's twice the B<Interval>-setting. If
567 unsure, don't set this option.
568
569 =item B<RRARows> I<NumRows>
570
571 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
572 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
573 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
574 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
575 week, one month, and one year.
576
577 So for each timespan, it calculates how many PDPs need to be consolidated into
578 one CDP by calculating:
579   number of PDPs = timespan / (stepsize * rrarows)
580
581 Bottom line is, set this no smaller than the width of you graphs in pixels. The
582 default is 1200.
583
584 =item B<RRATimespan> I<Seconds>
585
586 Adds an RRA-timespan, given in seconds. Use this option mulitple times to have
587 more then one RRA. If this option is never used, the built-in default of (3600,
588 86400, 604800, 2678400, 31622400) is used.
589
590 For more information on how RRA-sizes are calculated see B<RRARows> above.
591
592 =item B<XFF> I<Factor>
593
594 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
595
596 =item B<CacheFlush> I<Seconds>
597
598 When the C<rrdtool plugin> uses a cache (by setting B<CacheTimeout>, see below)
599 it writes all values for a certain RRD-file if the oldest value is older than
600 (or equal to) the number of seconds specified. If some RRD-file is not updated
601 anymore for some reason (the computer was shut down, the network is broken,
602 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
603 entire cache is searched for entries older than B<CacheTimeout> seconds and
604 written to disk every I<Seconds> seconds. Since this is kind of expensive and
605 does nothing under normal circumstances, this value should not be too small.
606 900 seconds might be a good value, though setting this to 7200 seconds doesn't
607 normally do much harm either.
608
609 =item B<CacheTimeout> I<Seconds>
610
611 If this option is set to a value greater than zero, the C<rrdtool plugin> will
612 save values in a cache, as described above. Writing multiple values at once
613 reduces IO-operations and thus lessens the load produced by updating the files.
614 The tradeoff is that the graphs kind of "drag behind" and that more memory is
615 used.
616
617 =back
618
619 =head2 Plugin C<sensors>
620
621 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
622 that all the needed modules have to be loaded and lm_sensors has to be
623 configured (most likely by editing F</etc/sensors.conf>. Read
624 L<sensors.conf(5)> for details.
625
626 The B<lm_sensors> homepage can be found at
627 L<http://secure.netroedge.com/~lm78/>.
628
629 =over 4
630
631 =item B<Sensor> I<chip-bus-address/type-feature>
632
633 Selects the name of the sensor which you want to collect or ignore, depending
634 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
635 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
636 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
637
638 =item B<IgnoreSelected> I<true>|I<false>
639
640 If no configuration if given, the B<sensors>-plugin will collect data from all
641 sensors. This may not be practical, especially for uninteresting sensors.
642 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
643 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
644 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
645 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
646 and all other sensors are collected.
647
648 =back
649
650 =head2 Plugin C<syslog>
651
652 =over 4
653
654 =item B<LogLevel> B<debug|info|notice|warning|err>
655
656 Sets the log-level. If, for example, set to B<notice>, then all events with
657 severity B<notice>, B<warning>, or B<err> will be submitted to the
658 syslog-daemon.
659
660 =back
661
662 =head2 Plugin C<unixsock>
663
664 =over 4
665
666 =item B<SocketFile> I<Path>
667
668 Sets the socket-file which is to be created.
669
670 =item B<SocketGroup> I<Group>
671
672 If running as root change the group of the UNIX-socket after it has been 
673 created. Defaults to B<collectd>.
674
675 =item B<SocketPerms> I<Permissions>
676
677 Change the file permissions of the UNIX-socket after it has been created. The
678 permissions must be given as a numeric, octal value as you would pass to
679 L<chmod(1)>. Defaults to B<0770>.
680
681 =back
682
683 =head2 Plugin C<vserver>
684
685 This plugin doesn't have any options. B<VServer> support is only available for
686 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
687 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
688 need to apply the patches and compile your own kernel, which will then provide
689 the F</proc/virtual> filesystem that is required by this plugin.
690
691 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
692
693 =head1 SEE ALSO
694
695 L<collectd(1)>,
696 L<collectd-exec(5)>,
697 L<collectd-unixsock(5)>,
698 L<hddtemp(8)>,
699 L<kstat(3KSTAT)>,
700 L<mbmon(1)>,
701 L<rrdtool(1)>,
702 L<sensors(1)>
703
704 =head1 AUTHOR
705
706 Florian Forster E<lt>octo@verplant.orgE<gt>
707
708 =cut