Code

irq plugin: Fixed some issues, renamed RRD-files.
[collectd.git] / src / collectd.pod
1 =head1 NAME
3 collectd - System statistics collection daemon
5 =head1 SYNOPSIS
7 collectd I<[options]>
9 =head1 DESCRIPTION
11 collectd is a daemon that collects various system statistics periodically and
12 stores them into RRD-files. Which data is collected depends on compile-time
13 settings. The following features may be available:
15 =over 4
17 =item
19 Apache server stats (I<apache>)
21 =item
23 Apple hardware sensors (I<apple_sensors>, Darwin only)
25 =item
27 Battery status (I<battery>)
29 =item
31 CPU utilization (I<cpu>)
33 =item
35 Mountpoint usage (I<df>)
37 =item
39 Disk and partition usage/throughput (I<disk>)
41 =item
43 DNS traffic (I<dns>)
45 =item
47 Email usage (I<email>)
49 =item
51 Harddisk temperatures (I<hddtemp>)
53 =item
55 Irq (I<irq>)
57 =item
59 System load averages (I<load>)
61 =item
63 Motherboard monitor (I<mbmon>)
65 =item
67 Memory usage (I<memory>)
69 =item
71 MySQL statistics (I<mysql>)
73 =item
75 NFS utilization (I<nfs>, Linux only)
77 =item
79 Network latency (I<ping>)
81 =item
83 Number of processes (I<processes>, Linux only)
85 =item
87 lm_sensors information (I<sensors>, Linux only)
89 =item
91 Serial port traffic (I<serial>, Linux only)
93 =item
95 Swap usage (I<swap>)
97 =item
99 Tape drive usage (I<tape>, Solaris only)
101 =item
103 Network traffic (I<traffic>)
105 =item
107 Number of users logged into the system (I<users>)
109 =item
111 System ressources used by VServers (I<vserver>)
113 =item
115 Wireless network stats (I<wireless>)
117 =back
119 =head1 OPTIONS
121 =over 4
123 =item B<-C> I<E<lt>config-fileE<gt>>
125 Specify an alternative config file. This is the place to go when you wish to
126 change B<collectd>'s behavior. The path may be relative to the current working
127 directory.
129 =item B<-P> I<E<lt>pid-fileE<gt>>
131 Specify an alternative pid file. This overwrites any settings in the config 
132 file. This is thought for init-scripts that require the PID-file in a certain
133 directory to work correctly. For everyday-usage use the B<PIDFile>
134 config-option.
136 =item B<-f>
138 Don't fork to the background. I<collectd> will also B<not> close standard file
139 descriptors, detach from the session nor write a pid file. This is mainly
140 thought for 'supervisioning' init replacements such as I<runit>.
142 =item B<-h>
144 Output usage information and exit.
146 =back
148 =head1 MODES
150 collectd can operate in four different operating modes. The modes are described
151 below.
153 The simplest mode is the so called B<local mode>. Data is collected locally and
154 written in RRD files that reside in I<DataDir>. This is the default mode when
155 collectd is linked against C<librrd>.
157 The modes B<client mode> and B<server mode> are used to send data over a
158 network and receive it again.
160 In B<client mode> the daemon collects the data locally and sends its results
161 to one or more network addresses. No RRD files are written locally in this
162 case. If collectd is not linked against C<librrd> this is the default mode.
164 If started in B<server mode> the daemon will listen on one or more interfaces
165 and write the data it receives to RRD files. No data is collected locally.
167 In the last mode, B<log mode>, data is collected locally and written in
168 text files that reside in I<DataDir>.
170 Please refer to L<collectd.conf(5)> for the configuration options and default
171 values.
173 =head1 SPECIAL PLUGINS
175 =head2 apache
177 This module connects to an Apache webserver and expects the output produced by
178 B<mod_status.c>. If requires B<libcurl> to set up the HTTP connection and issue
179 the request(s). The following is a sample config for the Apache webserver. The
180 use of C<ExtendedStatus on> is mandatory.
182   ExtendedStatus on
183   <IfModule mod_status.c>
184     <Location /mod_status>
185       SetHandler server-status
186     </Location>
187   </IfModule>
189 This plugin requires further configuration. Please read L<collectd.conf(5)>.
191 =head2 cpufreq
193 This module reads F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for
194 the first CPU installed) to get the current CPU frequency. If this file does
195 not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
196 similar tool is installed and an "cpu governor" (that's kernel module) is
197 loaded.
199 =head2 email
201 This plugin collects data indirectly by providing a UNIX socket that external
202 programs can connect to. A simple line based protocol is used to communicate
203 with the plugin:
205 E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
207   e:<type>:<size>
209 If C<size> is less than or equal to zero, C<size> is ignored.
211 Spam score:
213   s:<value>
215 Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
217   c:<type1>[,<type2>,...]
219 Each line is limited to 256 characters (including the newline character). 
220 Longer lines will be ignored.
222 =head2 mysql
224 Requires B<mysqlclient> to be installed. It connects to the database when
225 started and keeps the connection up as long as possible. When the connection is
226 interrupted for whatever reason it will try to re-connect. The syslog will
227 contain loud complaints in case anything goes wrong.
229 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
230 C<Com_*> and C<Handler_*> which correspond to F<traffic-mysql.rrd>,
231 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
232 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
233 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
234 I<5.2.4. Server Status Variables> for an explanation of these values.
236 =head2 sensors
238 The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
239 that all the needed modules have to be loaded and lm_sensors has to be
240 configured (most likely by editing F</etc/sensors.conf>. Read
241 L<sensors.conf(5)> for details.
243 The B<lm_sensors> homepage can be found at
244 L<http://secure.netroedge.com/~lm78/>.
246 =head2 mbmon
248 The B<mbmon> module uses mbmon to retrieve temperature, voltage, etc.
250 collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>.
251 The B<Host> and B<Port> options can be used to change these
252 default values. See L<collectd.conf(5)> for details. C<mbmon> has to be
253 running to work correctly. If C<mbmon> is not running timeouts may appear
254 which may interfere with other statistics..
256 C<mbmon> must be run with the -r option ("print TAG and Value format");
257 Debian's /etc/init.d/mbmon script already does this, other people
258 will need to ensure that this is the case.
260 =head2 hddtemp
262 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
263 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
264 default values. See L<collectd.conf(5)> for details. C<hddtemp> has to be
265 running to work correctly. If C<hddtemp> is not running timeouts may appear
266 which may interfere with other statistics..
268 The B<hddtemp> homepage can be found at
269 L<http://www.guzu.net/linux/hddtemp.php>.
271 =head2 vserver
273 B<VServer> support is only available for Linux. It cannot yet be found in a 
274 vanilla kernel, though. To make use of this plugin you need a kernel that has 
275 B<VServer> support built in, i.e. you need to apply the patches and compile 
276 your own kernel, which will then provide the /proc/virtual filesystem that is
277 required by this plugin.
279 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
281 =head1 RRD FILES
283 The RRD files are created automatically. The size of the RRAs depend on the
284 compile time settings of I<step> and I<width>. With the default values (I<step>
285 = B<10>, I<width> = B<1200>) the following RRAs are created:
287   RRA:AVERAGE:0.1:1:8640
288   RRA:AVERAGE:0.1:50:1210
289   RRA:AVERAGE:0.1:223:1202
290   RRA:AVERAGE:0.1:2635:1201
291   RRA:MIN:0.1:1:8640
292   RRA:MIN:0.1:50:1210
293   RRA:MIN:0.1:223:1202
294   RRA:MIN:0.1:2635:1201
295   RRA:MAX:0.1:1:8640
296   RRA:MAX:0.1:50:1210
297   RRA:MAX:0.1:223:1202
298   RRA:MAX:0.1:2635:1201
300 By default collectd uses a 10 second I<step>. Thus the RRAs contain the
301 following timespans. If you've changed the I<step> at compile time you will
302 have calculate resolution and timespan yourself.
304   PDP per CDP |  Resolution  | Data points | Timespan
305   ------------+--------------+-------------+---------
306             1 | 10.0 seconds !        8640 ! 1 day
307            50 |  8.3 minutes |        1210 | 1 week
308           223 | 37.2 minutes |        1202 | 1 month
309          2635 |  7.3 hours   |        1201 | 1 year
311 The DS'es depend on the module creating the RRD files:
313 =over 4
315 =item Apache traffic (F<apache/apache_bytes.rrd>)
317   DS:count:COUNTER:HEARTBEAT:0:134217728
319 =item Apache requests (F<apache/apache_requests.rrd>)
321   DS:count:COUNTER:HEARTBEAT:0:1048576
323 =item Apache scoreboard (F<apache/apache_scoreboard-I<E<lt>nameE<gt>>.rrd>)
325   DS:count:GAUGE:HEARTBEAT:0:U
327 =item Apple temperature sensor (F<apple_sensors/temperature-I<E<lt>nameE<gt>>.rrd>)
329   DS:value:GAUGE:HEARTBEAT:U:U
331 =item Apple fanspeed sensor (F<apple_sensors/fanspeed-I<E<lt>nameE<gt>>.rrd>)
333   DS:value:GAUGE:HEARTBEAT:U:U
335 =item Battery charge (F<battery-I<E<lt>nameE<gt>>/charge.rrd>)
337   DS:charge:GAUGE:HEARTBEAT:0:U
339 =item Battery current (F<battery-I<E<lt>nameE<gt>>/current.rrd>)
341   DS:current:GAUGE:HEARTBEAT:U:U
343 =item Battery voltage (F<battery-I<E<lt>nameE<gt>>/voltage.rrd>)
345   DS:voltage:GAUGE:HEARTBEAT:U:U
347 =item CPU (F<cpu-I<E<lt>numE<gt>>.rrd>)
349   DS:user:COUNTER:HEARTBEAT:0:100
350   DS:nice:COUNTER:HEARTBEAT:0:100
351   DS:syst:COUNTER:HEARTBEAT:0:100
352   DS:idle:COUNTER:HEARTBEAT:0:100
353   DS:wait:COUNTER:HEARTBEAT:0:100
355 =item CPU frequency (F<cpufreq-I<E<lt>numE<gt>>.rrd>)
357   DS:value:GAUGE:HEARTBEAT:0:U
359 =item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
361   DS:used:GAUGE:HEARTBEAT:0:U
362   DS:free:GAUGE:HEARTBEAT:0:U
364 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
366   DS:rcount:COUNTER:HEARTBEAT:0:U
367   DS:rmerged:COUNTER:HEARTBEAT:0:U
368   DS:rbytes:COUNTER:HEARTBEAT:0:U
369   DS:rtime:COUNTER:HEARTBEAT:0:U
370   DS:wcount:COUNTER:HEARTBEAT:0:U
371   DS:wmerged:COUNTER:HEARTBEAT:0:U
372   DS:wbytes:COUNTER:HEARTBEAT:0:U
373   DS:wtime:COUNTER:HEARTBEAT:0:U
375 =item Diskstats (F<partition-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
377   DS:rcount:COUNTER:HEARTBEAT:0:U
378   DS:rbytes:COUNTER:HEARTBEAT:0:U
379   DS:wcount:COUNTER:HEARTBEAT:0:U
380   DS:wbytes:COUNTER:HEARTBEAT:0:U
382 =item E-Mail count (F<email/email-I<E<lt>typeE<gt>>.rrd>)
384   DS:count:GAUGE:HEARTBEAT:0:U
386 =item E-Mail size (F<email/email_size-I<E<lt>typeE<gt>>.rrd>)
388   DS:size:GAUGE:HEARTBEAT:0:U
390 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
392   DS:value:GAUGE:HEARTBEAT:U:U
394 =item Irq (F<irq-I<E<lt>irqnumberE<gt>>.rrd>)
396   DS:value:COUNTER:HEARTBEAT:0:65535
398 =item System load (F<load.rrd>)
400   DS:shortterm:GAUGE:HEARTBEAT:0:100
401   DS:midterm:GAUGE:HEARTBEAT:0:100
402   DS:longterm:GAUGE:HEARTBEAT:0:100
404 =item Memory usage (F<memory.rrd>)
406   DS:used:GAUGE:HEARTBEAT:0:9223372036854775807
407   DS:free:GAUGE:HEARTBEAT:0:9223372036854775807
408   DS:buffers:GAUGE:HEARTBEAT:0:9223372036854775807
409   DS:cached:GAUGE:HEARTBEAT:0:9223372036854775807
411 =item MySQL commands and handlers (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
413   DS:value:COUNTER:HEARTBEAT:0:U
415 =item MySQL query cache (F<mysql_qcache.rrd>)
417   DS:hits:COUNTER:HEARTBEAT:0:U
418   DS:inserts:COUNTER:HEARTBEAT:0:U
419   DS:not_cached:COUNTER:HEARTBEAT:0:U
420   DS:lowmem_prunes:COUNTER:HEARTBEAT:0:U
421   DS:queries_in_cache:GAUGE:HEARTBEAT:0:U
423 =item MySQL threads (F<mysql_threads.rrd>)
425   DS:running:GAUGE:HEARTBEAT:0:U
426   DS:connected:GAUGE:HEARTBEAT:0:U
427   DS:cached:GAUGE:HEARTBEAT:0:U
428   DS:created:COUNTER:HEARTBEAT:0:U
430 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
432   DS:null:COUNTER:HEARTBEAT:0:U
433   DS:getattr:COUNTER:HEARTBEAT:0:U
434   DS:setattr:COUNTER:HEARTBEAT:0:U
435   DS:root:COUNTER:HEARTBEAT:0:U
436   DS:lookup:COUNTER:HEARTBEAT:0:U
437   DS:readlink:COUNTER:HEARTBEAT:0:U
438   DS:read:COUNTER:HEARTBEAT:0:U
439   DS:wrcache:COUNTER:HEARTBEAT:0:U
440   DS:write:COUNTER:HEARTBEAT:0:U
441   DS:create:COUNTER:HEARTBEAT:0:U
442   DS:remove:COUNTER:HEARTBEAT:0:U
443   DS:rename:COUNTER:HEARTBEAT:0:U
444   DS:link:COUNTER:HEARTBEAT:0:U
445   DS:symlink:COUNTER:HEARTBEAT:0:U
446   DS:mkdir:COUNTER:HEARTBEAT:0:U
447   DS:rmdir:COUNTER:HEARTBEAT:0:U
448   DS:readdir:COUNTER:HEARTBEAT:0:U
449   DS:fsstat:COUNTER:HEARTBEAT:0:U
451 =item NFSv3 Procedures (F<nfs3_procedures-I<(client|server)>.rrd>)
453   DS:null:COUNTER:HEARTBEAT:0:U
454   DS:getattr:COUNTER:HEARTBEAT:0:U
455   DS:setattr:COUNTER:HEARTBEAT:0:U
456   DS:lookup:COUNTER:HEARTBEAT:0:U
457   DS:access:COUNTER:HEARTBEAT:0:U
458   DS:readlink:COUNTER:HEARTBEAT:0:U
459   DS:read:COUNTER:HEARTBEAT:0:U
460   DS:write:COUNTER:HEARTBEAT:0:U
461   DS:create:COUNTER:HEARTBEAT:0:U
462   DS:mkdir:COUNTER:HEARTBEAT:0:U
463   DS:symlink:COUNTER:HEARTBEAT:0:U
464   DS:mknod:COUNTER:HEARTBEAT:0:U
465   DS:remove:COUNTER:HEARTBEAT:0:U
466   DS:rmdir:COUNTER:HEARTBEAT:0:U
467   DS:rename:COUNTER:HEARTBEAT:0:U
468   DS:link:COUNTER:HEARTBEAT:0:U
469   DS:readdir:COUNTER:HEARTBEAT:0:U
470   DS:readdirplus:COUNTER:HEARTBEAT:0:U
471   DS:fsstat:COUNTER:HEARTBEAT:0:U
472   DS:fsinfo:COUNTER:HEARTBEAT:0:U
473   DS:pathconf:COUNTER:HEARTBEAT:0:U
474   DS:commit:COUNTER:HEARTBEAT:0:U
476 =item Network latency / Ping (F<ping-I<E<lt>hostnameE<gt>>.rrd>)
478   DS:ping:GAUGE:HEARTBEAT:0:65535
480 =item Processes (F<processes.rrd>)
482   DS:running:GAUGE:HEARTBEAT:0:65535
483   DS:sleeping:GAUGE:HEARTBEAT:0:65535
484   DS:zombies:GAUGE:HEARTBEAT:0:65535
485   DS:stopped:GAUGE:HEARTBEAT:0:65535
486   DS:paging:GAUGE:HEARTBEAT:0:65535
487   DS:blocked:GAUGE:HEARTBEAT:0:65535
489 =item lm_sensors fanspeed sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/fanspeed-I<E<lt>instE<gt>>.rrd>)
491   DS:value:GAUGE:HEARTBEAT:U:U
493 =item lm_sensors temperature sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/temperature-I<E<lt>instE<gt>>.rrd>)
495   DS:value:GAUGE:HEARTBEAT:U:U
497 =item lm_sensors voltage sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/voltage-I<E<lt>instE<gt>>.rrd>)
499   DS:voltage:GAUGE:HEARTBEAT:U:U
501 =item Serial port traffic (F<serial-I<E<lt>numE<gt>>.rrd>)
503   DS:incoming:COUNTER:HEARTBEAT:0:U
504   DS:outgoing:COUNTER:HEARTBEAT:0:U
506 =item Spam score (F<email/spam_score.rrd>)
508   DS:score:GAUGE:HEARTBEAT:0:U
510 =item Spam checks (F<email/spam_check-I<E<lt>typeE<gt>>.rrd>)
512   DS:hits:GAUGE:HEARTBEAT:0:U
514 =item Swap usage (F<swap.rrd>)
516   DS:used:GAUGE:HEARTBEAT:0:1099511627776
517   DS:free:GAUGE:HEARTBEAT:0:1099511627776
518   DS:cached:GAUGE:HEARTBEAT:0:1099511627776
519   DS:resv:GAUGE:HEARTBEAT:0:1099511627776
521 =item Tape drive usage (F<tape-I<E<lt>nameE<gt>>.rrd>)
523   DS:rcount:COUNTER:HEARTBEAT:0:
524   DS:rmerged:COUNTER:HEARTBEAT:0:U
525   DS:rbytes:COUNTER:HEARTBEAT:0:U
526   DS:rtime:COUNTER:HEARTBEAT:0:U
527   DS:wcount:COUNTER:HEARTBEAT:0:U
528   DS:wmerged:COUNTER:HEARTBEAT:0:U
529   DS:wbytes:COUNTER:HEARTBEAT:0:U
530   DS:wtime:COUNTER:HEARTBEAT:0:U
532 =item Network traffic (F<traffic-I<E<lt>interfaceE<gt>>.rrd>)
534   DS:incoming:COUNTER:HEARTBEAT:0:U
535   DS:outgoing:COUNTER:HEARTBEAT:0:U
537 =item Interface packets (F<if_packets-I<E<lt>interfaceE<gt>>.rrd>)
539   DS:rx:COUNTER:HEARTBEAT:0:U
540   DS:tx:COUNTER:HEARTBEAT:0:U
542 =item Interface errors (F<if_errors-I<E<lt>interfaceE<gt>>.rrd>)
544   DS:rx:COUNTER:HEARTBEAT:0:U
545   DS:tx:COUNTER:HEARTBEAT:0:U
547 =item Users (F<users.rrd>)
549   DS:users:GAUGE:HEARTBEAT:0:65535
551 =item VServer load (F<vserver-I<E<lt>xidE<gt>>/load.rrd>)
553   DS:shortterm:GAUGE:HEARTBEAT:0:100
554   DS:midterm:GAUGE:HEARTBEAT:0:100
555   DS:longterm:GAUGE:HEARTBEAT:0:100
557 =item VServer threads (F<vserver-I<E<lt>xidE<gt>>/threads.rrd>)
559   DS:total:GAUGE:HEARTBEAT:0:65535
560   DS:running:GAUGE:HEARTBEAT:0:65535
561   DS:uninterruptible:GAUGE:HEARTBEAT:0:65535
562   DS:onhold:GAUGE:HEARTBEAT:0:65535
564 =item VServer network traffic (F<vserver-I<E<lt>xidE<gt>>/traffic-I<E<lt>nameE<gt>>.rrd>)
566   DS:incoming:COUNTER:HEARTBEAT:0:9223372036854775807
567   DS:outgoing:COUNTER:HEARTBEAT:0:9223372036854775807
568   DS:failed:COUNTER:HEARTBEAT:0:9223372036854775807
570 =item VServer processes (F<vserver-I<E<lt>xidE<gt>>/vs_processes.rrd>)
572   DS:total:GAUGE:HEARTBEAT:0:65535
574 =item VServer memory usage (F<vserver-I<E<lt>xidE<gt>>/vs_memory.rrd>)
576   DS:vm:GAUGE:HEARTBEAT:0:9223372036854775807
577   DS:vml:GAUGE:HEARTBEAT:0:9223372036854775807
578   DS:rss:GAUGE:HEARTBEAT:0:9223372036854775807
579   DS:anon:GAUGE:HEARTBEAT:0:9223372036854775807
581 =item Wireless link quality (F<wireless-I<E<lt>interfaceE<gt>>.rrd>)
583   DS:quality:GAUGE:HEARTBEAT:0:U
584   DS:power:GAUGE:HEARTBEAT:U:0
585   DS:noise:GAUGE:HEARTBEAT:U:0
587 =back
589 =head1 SEE ALSO
591 L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
592 L<mbmon(1)>,
593 L<kstat(3KSTAT)>
595 =head1 AUTHOR
597 Florian Forster E<lt>octo@verplant.orgE<gt>
599 =cut