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