1d83a26d9f1874eed53c28fe18f9955a487e7c97
[collectd.git] / README
1  collectd - System information collection daemon
2 =================================================
3 http://collectd.org/
4
5 About
6 -----
7
8   collectd is a small daemon which collects system information periodically
9   and provides mechanisms to store and monitor the values in a variety of
10   ways.
11
12
13 Features
14 --------
15
16   * collectd is able to collect the following data:
17
18     - apache
19       Apache server utilization: Number of bytes transfered, number of
20       requests handled and detailed scoreboard statistics
21
22     - apcups
23       APC UPS Daemon: UPS charge, load, input/output/battery voltage, etc.
24
25     - apple_sensors
26       Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and
27       voltage sensors.
28
29     - ascent
30       Statistics about Ascent, a free server for the game `World of Warcraft'.
31
32     - battery
33       Batterycharge, -current and voltage of ACPI and PMU based laptop
34       batteries.
35
36     - bind
37       Name server and resolver statistics from the `statistics-channel'
38       interface of BIND 9.5, 9,6 and later.
39
40     - conntrack
41       Number of nf_conntrack entries.
42
43     - contextswitch
44       Number of context switches done by the operating system.
45
46     - cpu
47       CPU utilization: Time spent in the system, user, nice, idle, and related
48       states.
49
50     - cpufreq
51       CPU frequency (For laptops with speed step or a similar technology)
52
53     - curl
54       Parse statistics from websites using regular expressions.
55
56     - curl_json
57       Retrieves JSON data via cURL and parses it according to user
58       configuration.
59
60     - dbi
61       Executes SQL statements on various databases and interprets the returned
62       data.
63
64     - df
65       Mountpoint usage (Basically the values `df(1)' delivers)
66
67     - disk
68       Disk utilization: Sectors read/written, number of read/write actions,
69       average time an IO-operation took to complete.
70
71     - dns
72       DNS traffic: Query types, response codes, opcodes and traffic/octets
73       transfered.
74
75     - email
76       Email statistics: Count, traffic, spam scores and checks.
77       See collectd-email(5).
78
79     - entropy
80       Amount of entropy available to the system.
81
82     - exec
83       Values gathered by a custom program or script.
84       See collectd-exec(5).
85
86     - filecount
87       Count the number of files in directories.
88
89     - fscache
90       Linux file-system based caching framework statistics.
91
92     - gmond
93       Receive multicast traffic from Ganglia instances.
94
95     - hddtemp
96       Harddisk temperatures using hddtempd.
97
98     - interface
99       Interface traffic: Number of octets, packets and errors for each
100       interface.
101
102     - iptables
103       Iptables' counters: Number of bytes that were matched by a certain
104       iptables rule.
105
106     - ipmi
107       IPMI (Intelligent Platform Management Interface) sensors information.
108
109     - ipvs
110       IPVS connection statistics (number of connections, octets and packets
111       for each service and destination).
112       See http://www.linuxvirtualserver.org/software/index.html.
113
114     - irq
115       IRQ counters: Frequency in which certain interrupts occur.
116
117     - java
118       Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
119       bytecode. See “Configuring with libjvm” below.
120
121     - load
122       System load average over the last 1, 5 and 15 minutes.
123
124     - libvirt
125       CPU, disk and network I/O statistics from virtual machines.
126
127     - madwifi
128       Queries very detailed usage statistics from wireless LAN adapters and
129       interfaces that use the Atheros chipset and the MadWifi driver.
130
131     - mbmon
132       Motherboard sensors: temperature, fanspeed and voltage information,
133       using mbmon(1).
134
135     - memcachec
136       Query and parse data from a memcache daemon (memcached).
137
138     - memcached
139       Statistics of the memcached distributed caching system.
140       <http://www.danga.com/memcached/>
141
142     - memory
143       Memory utilization: Memory occupied by running processes, page cache,
144       buffer cache and free.
145
146     - multimeter
147       Information provided by serial multimeters, such as the `Metex
148       M-4650CR'.
149
150     - mysql
151       MySQL server statistics: Commands issued, handlers triggered, thread
152       usage, query cache utilization and traffic/octets sent and received.
153
154     - netapp
155       Plugin to query performance values from a NetApp storage system using the
156       “Manage ONTAP” SDK provided by NetApp.
157
158     - netlink
159       Very detailed Linux network interface and routing statistics. You can get
160       (detailed) information on interfaces, qdiscs, classes, and, if you can
161       make use of it, filters.
162
163     - network
164       Receive values that were collected by other hosts. Large setups will
165       want to collect the data on one dedicated machine, and this is the
166       plugin of choice for that.
167
168     - nfs
169       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
170       NFSv3 right now.
171
172     - nginx
173       Collects statistics from `nginx' (speak: engine X), a HTTP and mail
174       server/proxy.
175
176     - ntpd
177       NTP daemon statistics: Local clock drift, offset to peers, etc.
178
179     - nut
180       Network UPS tools: UPS current, voltage, power, charge, utilisation,
181       temperature, etc. See upsd(8).
182
183     - olsrd
184       Queries routing information from the “Optimized Link State Routing”
185       daemon.
186
187     - onewire (EXPERIMENTAL!)
188       Read onewire sensors using the owcapu library of the owfs project.
189       Please read in collectd.conf(5) why this plugin is experimental.
190
191     - openvpn
192       RX and TX of each client in openvpn-status.log (status-version 2).
193       <http://openvpn.net/index.php/documentation/howto.html>
194
195     - oracle
196       Query data from an Oracle database.
197
198     - perl
199       The perl plugin implements a Perl-interpreter into collectd. You can
200       write your own plugins in Perl and return arbitrary values using this
201       API. See collectd-perl(5).
202
203     - ping
204       Network latency: Time to reach the default gateway or another given
205       host.
206
207     - postgresql
208       PostgreSQL database statistics: active server connections, transaction
209       numbers, block IO, table row manipulations.
210
211     - powerdns
212       PowerDNS name server statistics.
213
214     - processes
215       Process counts: Number of running, sleeping, zombie, ... processes.
216
217     - protocols
218       Counts various aspects of network protocols such as IP, TCP, UDP, etc.
219
220     - python
221       The python plugin implements a Python interpreter into collectd. This
222       makes it possible to write plugins in Python which are executed by
223       collectd without the need to start a heavy interpreter every interval.
224       See collectd-python(5) for details.
225
226     - routeros
227       Query interface and wireless registration statistics from RouterOS.
228
229     - rrdcached
230       RRDtool caching daemon (RRDcacheD) statistics.
231
232     - sensors
233       System sensors, accessed using lm_sensors: Voltages, temperatures and
234       fan rotation speeds.
235
236     - serial
237       RX and TX of serial interfaces. Linux only; needs root privileges.
238
239     - snmp
240       Read values from SNMP (Simple Network Management Protocol) enabled
241       network devices such as switches, routers, thermometers, rack monitoring
242       servers, etc. See collectd-snmp(5).
243
244     - swap
245       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
246
247     - table
248       Parse table-like structured files.
249
250     - tail
251       Follows (tails) logfiles, parses them by lines and submits matched
252       values.
253
254     - tape
255       Bytes and operations read and written on tape devices. Solaris only.
256
257     - tcpconns
258       Number of TCP connections to specific local and remote ports.
259
260     - teamspeak2
261       TeamSpeak2 server statistics.
262
263     - ted
264       Plugin to read values from `The Energy Detective' (TED).
265
266     - thermal
267       Linux ACPI thermal zone information.
268
269     - tokyotyrant
270       Reads the number of records and file size from a running Tokyo Tyrant
271       server.
272
273     - uptime
274       System uptime statistics.
275
276     - users
277       Users currently logged in.
278
279     - vmem
280       Virtual memory statistics, e. g. the number of page-ins/-outs or the
281       number of pagefaults.
282
283     - vserver
284       System resources used by Linux VServers.
285       See <http://linux-vserver.org/>.
286
287     - wireless
288       Link quality of wireless cards. Linux only.
289
290     - xmms
291       Bitrate and frequency of music played with XMMS.
292
293     - zfs_arc
294       Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
295
296   * Output can be written or send to various destinations by the following
297     plugins:
298
299     - csv
300       Write to comma separated values (CSV) files. This needs lots of
301       diskspace but is extremely portable and can be analysed with almost
302       every program that can analyse anything. Even Microsoft's Excel..
303
304     - network
305       Send the data to a remote host to save the data somehow. This is useful
306       for large setups where the data should be saved by a dedicated machine.
307
308     - perl
309       Of course the values are propagated to plugins written in Perl, too, so
310       you can easily do weird stuff with the plugins we didn't dare think of
311       ;) See collectd-perl(5).
312
313     - python
314       It's possible to implement write plugins in Python using the python
315       plugin. See collectd-python(5) for details.
316
317     - rrdcached
318       Output to round-robin-database (RRD) files using the RRDtool caching
319       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
320       implementation of the caching done by the `rrdtool' plugin.
321
322     - rrdtool
323       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
324       This is likely the most popular destination for such values. Since
325       updates to RRD-files are somewhat expensive this plugin can cache
326       updates to the files and write a bunch of updates at once, which lessens
327       system load a lot.
328
329     - unixsock
330       One can query the values from the unixsock plugin whenever they're
331       needed. Please read collectd-unixsock(5) for a description on how that's
332       done.
333
334     - write_http
335       Sends the values collected by collectd to a web-server using HTTP POST
336       requests. The transmitted data is either in a form understood by the
337       Exec plugin or formatted in JSON.
338
339   * Logging is, as everything in collectd, provided by plugins. The following
340     plugins keep up informed about what's going on:
341
342     - logfile
343       Writes logmessages to a file or STDOUT/STDERR.
344
345     - perl
346       Log messages are propagated to plugins written in Perl as well.
347       See collectd-perl(5).
348
349     - python
350       It's possible to implement log plugins in Python using the python plugin.
351       See collectd-python(5) for details.
352
353     - syslog
354       Logs to the standard UNIX logging mechanism, syslog.
355
356   * Notifications can be handled by the following plugins:
357
358     - notify_desktop
359       Send a desktop notification to a notification daemon, as defined in
360       the Desktop Notification Specification. To actually display the
361       notifications, notification-daemon is required.
362       See http://www.galago-project.org/specs/notification/.
363
364     - notify_email
365       Send an E-mail with the notification message to the configured
366       recipients.
367
368     - exec
369       Execute a program or script to handle the notification.
370       See collectd-exec(5).
371
372     - logfile
373       Writes the notification message to a file or STDOUT/STDERR.
374
375     - network
376       Send the notification to a remote host to handle it somehow.
377
378     - perl
379       Notifications are propagated to plugins written in Perl as well.
380       See collectd-perl(5).
381
382     - python
383       It's possible to implement notification plugins in Python using the
384       python plugin. See collectd-python(5) for details.
385
386   * Value processing can be controlled using the "filter chain" infrastructure
387     and "matches" and "targets". The following plugins are available:
388
389     - match_empty_counter
390       Match counter values which are currently zero.
391
392     - match_hashed
393       Match values using a hash function of the hostname.
394
395     - match_regex
396       Match values by their identifier based on regular expressions.
397
398     - match_timediff
399       Match values with an invalid timestamp.
400
401     - match_value
402       Select values by their data sources' values.
403
404     - target_notification
405       Create and dispatch a notification.
406
407     - target_replace
408       Replace parts of an identifier using regular expressions.
409
410     - target_scale
411       Scale (multiply) values by an arbitrary value.
412
413     - target_set
414       Set (overwrite) entire parts of an identifier.
415
416   * Miscellaneous plugins:
417
418     - uuid
419       Sets the hostname to an unique identifier. This is meant for setups
420       where each client may migrate to another physical host, possibly going
421       through one or more name changes in the process.
422
423   * Performance: Since collectd is running as a daemon it doesn't spend much
424     time starting up again and again. With the exception of the exec plugin no
425     processes are forked. Caching in output plugins, such as the rrdtool and
426     network plugins, makes sure your resources are used efficiently. Also,
427     since collectd is programmed multithreaded it benefits from hyperthreading
428     and multicore processors and makes sure that the daemon isn't idle if only
429     one plugins waits for an IO-operation to complete.
430
431   * Once set up, hardly any maintenance is necessary. Setup is kept as easy
432     as possible and the default values should be okay for most users.
433
434
435 Operation
436 ---------
437
438   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
439     Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
440     for a list of options and a syntax description.
441
442   * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
443     files. The usual place for these files is beneath `/var/lib/collectd'.
444
445   * When using some of the plugins, collectd needs to run as user root, since
446     only root can do certain things, such as craft ICMP packages needed to ping
447     other hosts. collectd should NOT be installed setuid root since it can be
448     used to overwrite valuable files!
449
450   * Sample scripts to generate graphs reside in `contrib/' in the source
451     package or somewhere near `/usr/share/doc/collectd' in most distributions.
452     Please be aware that those script are meant as a starting point for your
453     own experiments.. Some of them require the `RRDs' Perl module.
454     (`librrds-perl' on Debian) If you have written a more sophisticated
455     solution please share it with us.
456
457   * The RRAs of the automatically created RRD files depend on the `step'
458     and `heartbeat' settings given. If change these settings you may need to
459     re-create the files, losing all data. Please be aware of that when changing
460     the values and read the rrdtool(1) manpage thoroughly.
461
462
463 collectd and chkrootkit
464 -----------------------
465
466   If you are using the `dns' plugin chkrootkit(1) will report collectd as a
467   packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
468   plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
469   this case, collectd is a legitimate sniffer and the report should be
470   considered to be a false positive. However, you might want to check that
471   this really is collectd and not some other, illegitimate sniffer.
472
473
474 Prerequisites
475 -------------
476
477   To compile collectd from source you will need:
478
479   * Usual suspects: C compiler, linker, preprocessor, make, ...
480
481   * A POSIX-threads (pthread) implementation.
482     Since gathering some statistics is slow (network connections, slow devices,
483     etc) the collectd is parallelized. The POSIX threads interface is being
484     used and should be found in various implementations for hopefully all
485     platforms.
486
487   * CoreFoundation.framework and IOKit.framework (optional)
488     For compiling on Darwin in general and the `apple_sensors' plugin in
489     particular.
490     <http://developer.apple.com/corefoundation/>
491
492   * libclntsh (optional)
493     Used by the `oracle' plugin.
494
495   * libcurl (optional)
496     If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
497     plugin.
498     <http://curl.haxx.se/>
499
500   * libdbi (optional)
501     Used by the `dbi' plugin to connect to various databases.
502     <http://libdbi.sourceforge.net/>
503
504   * libesmtp (optional)
505     For the `notify_email' plugin.
506     <http://www.stafford.uklinux.net/libesmtp/>
507
508   * libganglia (optional)
509     Used by the `gmond' plugin to process data received from Ganglia.
510     <http://ganglia.info/>
511
512   * libgcrypt (optional)
513     Used by the `network' plugin for encryption and authentication.
514     <http://www.gnupg.org/>
515
516   * libhal (optional)
517     If present, the uuid plugin will check for UUID from HAL.
518     <http://hal.freedesktop.org/>
519
520   * libiptc (optional)
521     For querying iptables counters.
522     <http://netfilter.org/>
523
524     If not found on the system, a version shipped with this distribution can
525     be used. It requires some Linux headers in /usr/include/linux. You can
526     force the build system to use the shipped version by specifying
527       --with-libiptc=shipped
528     when running the configure script.
529
530   * libjvm (optional)
531     Library that encapsulates the `Java Virtual Machine' (JVM). This library is
532     used by the Java plugin to execute Java bytecode. See “Configuring with
533     libjvm” below.
534     <http://openjdk.java.net/> (and others)
535
536   * libmemcached (optional)
537     Used by the `memcachec' plugin to connect to a memcache daemon.
538     <http://tangent.org/552/libmemcached.html>
539
540   * libmysqlclient (optional)
541     Unsurprisingly used by the `mysql' plugin.
542     <http://dev.mysql.com/>
543
544   * libnetapp (optional)
545     Required for the “netapp” plugin.
546     This library is part of the “Manage ONTAP SDK” published by NetApp.
547
548   * libnetlink (optional)
549     Used, obviously, for the `netlink' plugin.
550     <http://www.linuxfoundation.org/en/Net:Iproute2>
551
552   * libnetsnmp (optional)
553     For the `snmp' plugin.
554     <http://www.net-snmp.org/>
555
556   * libnotify (optional)
557     For the `notify_desktop' plugin.
558     <http://www.galago-project.org/>
559
560   * liboping (optional)
561     Used by the `ping' plugin to send and receive ICMP packets.
562     <http://verplant.org/liboping/>
563
564   * libowcapi (optional)
565     Used by the `onewire' plugin to read values from onewire sensors (or the
566     owserver(1) daemon).
567     <http://www.owfs.org/>
568
569   * libpcap (optional)
570     Used to capture packets by the `dns' plugin.
571     <http://www.tcpdump.org/>
572
573   * libperl (optional)
574     Obviously used by the `perl' plugin. The library has to be compiled with
575     ithread support (introduced in Perl 5.6.0).
576     <http://www.perl.org/>
577
578   * libpq (optional)
579     The PostgreSQL C client library used by the `postgresql' plugin.
580     <http://www.postgresql.org/>
581
582   * libpython (optional)
583     Used by the `python' plugin. Currently, only 2.3 ≦ Python < 3 is supported.
584     <http://www.python.org/>
585
586   * librouteros (optional)
587     Used by the `routeros' plugin to connect to a device running `RouterOS'.
588     <http://verplant.org/librouteros/>
589
590   * librrd (optional)
591     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
592     client support which was added after version 1.3 of RRDtool. Versions 1.0,
593     1.2 and 1.3 are known to work with the `rrdtool' plugin.
594     <http://oss.oetiker.ch/rrdtool/>
595
596   * librt, libsocket, libkstat, libdevinfo (optional)
597     Various standard Solaris libraries which provide system functions.
598     <http://developers.sun.com/solaris/>
599
600   * libsensors (optional)
601     To read from `lm_sensors', see the `sensors' plugin.
602     <http://www.lm-sensors.org/>
603
604   * libstatgrab (optional)
605     Used by various plugins to collect statistics on systems other than Linux
606     and/or Solaris.
607     <http://www.i-scream.org/libstatgrab/>
608
609   * libtokyotyrant (optional)
610     Used by the tokyotyrant plugin.
611     <http://1978th.net/tokyotyrant/>
612
613   * libupsclient/nut (optional)
614     For the `nut' plugin which queries nut's `upsd'.
615     <http://networkupstools.org/>
616
617   * libvirt (optional)
618     Collect statistics from virtual machines.
619     <http://libvirt.org/>
620
621   * libxml2 (optional)
622     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
623     <http://xmlsoft.org/>
624
625   * libxmms (optional)
626     <http://www.xmms.org/>
627
628   * libyajl (optional)
629     Parse JSON data. This is needed for the `curl_json' plugin.
630     <http://github.com/lloyd/yajl>
631
632 Configuring / Compiling / Installing
633 ------------------------------------
634
635   To configure, build and install collectd with the default settings, run
636   `./configure && make && make install'.  For detailed, generic instructions
637   see INSTALL. For a complete list of configure options and their description,
638   run `./configure --help'.
639
640   By default, the configure script will check for all build dependencies and
641   disable all plugins whose requirements cannot be fulfilled (any other plugin
642   will be enabled). To enable a plugin, install missing dependencies (see
643   section `Prerequisites' above) and rerun `configure'. If you specify the
644   `--enable-<plugin>' configure option, the script will fail if the depen-
645   dencies for the specified plugin are not met. In that case you can force the
646   plugin to be built using the `--enable-<plugin>=force' configure option.
647   This will most likely fail though unless you're working in a very unusual
648   setup and you really know what you're doing. If you specify the
649   `--disable-<plugin>' configure option, the plugin will not be built. If you
650   specify the `--enable-all-plugins' or `--disable-all-plugins' configure
651   options, all plugins will be enabled or disabled respectively by default.
652   Explicitly enabling or disabling a plugin overwrites the default for the
653   specified plugin. These options are meant for package maintainers and should
654   not be used in everyday situations.
655
656   By default, collectd will be installed into `/opt/collectd'. You can adjust
657   this setting by specifying the `--prefix' configure option - see INSTALL for
658   details. If you pass DESTDIR=<path> to `make install', <path> will be
659   prefixed to all installation directories. This might be useful when creating
660   packages for collectd.
661
662 Configuring with libjvm
663 -----------------------
664
665   To determine the location of the required files of a Java installation is not
666   an easy task, because the locations vary with your kernel (Linux, SunOS, …)
667   and with your architecture (x86, SPARC, …) and there is no ‘java-config’
668   script we could use. Configuration of the JVM library is therefore a bit
669   tricky.
670
671   The easiest way to use the `--with-java=$JAVA_HOME' option, where
672   `$JAVA_HOME' is usually something like:
673     /usr/lib/jvm/java-1.5.0-sun-1.5.0.14
674
675   The configure script will then use find(1) to look for the following files:
676
677     - jni.h
678     - jni_md.h
679     - libjvm.so
680
681   If found, appropriate CPP-flags and LD-flags are set and the following
682   library checks succeed.
683
684   If this doesn't work for you, you have the possibility to specify CPP-flags,
685   C-flags and LD-flags for the ‘Java’ plugin by hand, using the following three
686   (environment) variables:
687
688     - JAVA_CPPFLAGS
689     - JAVA_CFLAGS
690     - JAVA_LDFLAGS
691
692   For example (shortened for demonstration purposes):
693
694     ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
695
696   Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
697   do that.
698
699 Crosscompiling
700 --------------
701
702   To compile correctly collectd needs to be able to initialize static
703   variables to NAN (Not A Number). Some C libraries, especially the GNU
704   libc, have a problem with that.
705
706   Luckily, with GCC it's possible to work around that problem: One can define
707   NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
708   ``implementation'' the configure script needs to compile and run a short
709   test program. Obviously running a test program when doing a cross-
710   compilation is, well, challenging.
711
712   If you run into this problem, you can use the `--with-nan-emulation'
713   configure option to force the use of this implementation. We can't promise
714   that the compiled binary actually behaves as it should, but since NANs
715   are likely never passed to the libm you have a good chance to be lucky.
716
717   Likewise, collectd needs to know the layout of doubles in memory, in order
718   to craft uniform network packets over different architectures. For this, it
719   needs to know how to convert doubles into the memory layout used by x86. The
720   configure script tries to figure this out by compiling and running a few
721   small test programs. This is of course not possible when cross-compiling.
722   You can use the `--with-fp-layout' option to tell the configure script which
723   conversion method to assume. Valid arguments are:
724
725     * `nothing'    (12345678 -> 12345678)
726     * `endianflip' (12345678 -> 87654321)
727     * `intswap'    (12345678 -> 56781234)
728
729
730 Contact
731 -------
732
733   For questions, bug reports, development information and basically all other
734   concerns please send an email to collectd's mailing list at
735   <collectd at verplant.org>.
736
737   For live discussion and more personal contact visit us in IRC, we're in
738   channel #collectd on freenode.
739
740
741 Author
742 ------
743
744   Florian octo Forster <octo at verplant.org>,
745   Sebastian tokkee Harl <sh at tokkee.org>,
746   and many contributors (see `AUTHORS').
747
748   Please send bug reports and patches to the mailing list, see `Contact'
749   above.
750