Use -Wall -Werror (AM_CFLAGS) when building any module.
[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     - cpu
37       CPU utilization: Time spent in the system, user, nice, idle, and related
38       states.
39
40     - cpufreq
41       CPU frequency (For laptops with speed step or a similar technology)
42
43     - df
44       Mountpoint usage (Basically the values `df(1)' delivers)
45
46     - disk
47       Disk utilization: Sectors read/written, number of read/write actions,
48       average time an IO-operation took to complete.
49
50     - dns
51       DNS traffic: Query types, response codes, opcodes and traffic/octets
52       transfered.
53
54     - email
55       Email statistics: Count, traffic, spam scores and checks.
56       See collectd-email(5).
57
58     - entropy
59       Amount of entropy available to the system.
60
61     - exec
62       Values gathered by a custom program or script.
63       See collectd-exec(5).
64
65     - hddtemp
66       Harddisk temperatures using hddtempd.
67
68     - interface
69       Interface traffic: Number of octets, packets and errors for each
70       interface.
71
72     - iptables
73       Iptables' counters: Number of bytes that were matched by a certain
74       iptables rule.
75
76     - ipvs
77       IPVS connection statistics (number of connections, octets and packets
78       for each service and destination).
79       See http://www.linuxvirtualserver.org/software/index.html.
80
81     - irq
82       IRQ counters: Frequency in which certain interrupts occur.
83
84     - load
85       System load average over the last 1, 5 and 15 minutes.
86
87     - libvirt
88       CPU, disk and network I/O statistics from virtual machines.
89
90     - mbmon
91       Motherboard sensors: temperature, fanspeed and voltage information,
92       using mbmon(1).
93
94     - memcached
95       Statistics of the memcached distributed caching system.
96       <http://www.danga.com/memcached/>
97
98     - memory
99       Memory utilization: Memory occupied by running processes, page cache,
100       buffer cache and free.
101
102     - multimeter
103       Information provided by serial multimeters, such as the `Metex
104       M-4650CR'.
105
106     - mysql
107       MySQL server statistics: Commands issued, handlers triggered, thread
108       usage, query cache utilization and traffic/octets sent and received.
109
110     - netlink
111       Very detailed Linux network interface and routing statistics. You can get
112       (detailed) information on interfaces, qdiscs, classes, and, if you can
113       make use of it, filters.
114
115     - network
116       Receive values that were collected by other hosts. Large setups will
117       want to collect the data on one dedicated machine, and this is the
118       plugin of choice for that.
119
120     - nfs
121       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
122       NFSv3 right now.
123
124     - nginx
125       Collects statistics from `nginx' (speak: engine X), a HTTP and mail
126       server/proxy.
127
128     - ntpd
129       NTP daemon statistics: Local clock drift, offset to peers, etc.
130
131     - nut
132       Network UPS tools: UPS current, voltage, power, charge, utilisation,
133       temperature, etc. See upsd(8).
134
135     - perl
136       The perl plugin implements a Perl-interpreter into collectd. You can
137       write your own plugins in Perl and return arbitrary values using this
138       API. See collectd-perl(5).
139
140     - ping
141       Network latency: Time to reach the default gateway or another given
142       host.
143
144     - processes
145       Process counts: Number of running, sleeping, zombie, ... processes.
146
147     - sensors
148       System sensors, accessed using lm_sensors: Voltages, temperatures and
149       fan rotation speeds.
150
151     - serial
152       RX and TX of serial interfaces. Linux only; needs root privileges.
153
154     - snmp
155       Read values from SNMP (Simple Network Management Protocol) enabled
156       network devices such as switches, routers, thermometers, rack monitoring
157       servers, etc. See collectd-snmp(5).
158
159     - swap
160       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
161
162     - tail
163       Follows (tails) logfiles, parses them by lines and submits matched
164       values.
165
166     - tape
167       Bytes and operations read and written on tape devices. Solaris only.
168
169     - tcpconns
170       Number of TCP connections to specific local and remote ports.
171
172     - users
173       Users currently logged in.
174
175     - vmem
176       Virtual memory statistics, e. g. the number of page-ins/-outs or the
177       number of pagefaults.
178
179     - vserver
180       System resources used by Linux VServers.
181       See <http://linux-vserver.org/>.
182
183     - wireless
184       Link quality of wireless cards. Linux only.
185
186     - xmms
187       Bitrate and frequency of music played with XMMS.
188
189   * Output can be written or send to various destinations by the following
190     plugins:
191
192     - csv
193       Write to comma separated values (CSV) files. This needs lots of
194       diskspace but is extremely portable and can be analysed with almost
195       every program that can analyse anything. Even Microsoft's Excel..
196
197     - network
198       Send the data to a remote host to save the data somehow. This is useful
199       for large setups where the data should be saved by a dedicated machine.
200
201     - perl
202       Of course the values are propagated to plugins written in Perl, too, so
203       you can easily do weird stuff with the plugins we didn't dare think of
204       ;) See collectd-perl(5).
205
206     - rrdtool
207       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
208       This is likely the most popular destination for such values. Since
209       updates to RRD-files are somewhat expensive this plugin can cache
210       updates to the files and write a bunch of updates at once, which lessens
211       system load a lot.
212
213     - unixsock
214       One can query the values from the unixsock plugin whenever they're
215       needed. Please read collectd-unixsock(5) for a description on how that's
216       done.
217
218   * Logging is, as everything in collectd, provided by plugins. The following
219     plugins keep up informed about what's going on:
220
221     - logfile
222       Writes logmessages to a file or STDOUT/STDERR.
223
224     - perl
225       Log messages are propagated to plugins written in Perl as well.
226       See collectd-perl(5).
227
228     - syslog
229       Logs to the standard UNIX logging mechanism, syslog.
230
231   * Notifications can be handled by the following plugins:
232
233     - notify_desktop
234       Send a desktop notification to a notification daemon, as defined in
235       the Desktop Notification Specification. To actually display the
236       notifications, notification-daemon is required.
237       See http://www.galago-project.org/specs/notification/.
238
239     - notify_email
240       Send an E-mail with the notification message to the configured
241       recipients.
242
243     - exec
244       Execute a program or script to handle the notification.
245       See collectd-exec(5).
246
247     - logfile
248       Writes the notification message to a file or STDOUT/STDERR.
249
250     - network
251       Send the notification to a remote host to handle it somehow.
252
253     - perl
254       Notifications are propagated to plugins written in Perl as well.
255       See collectd-perl(5).
256
257   * Miscellaneous plugins:
258
259     - uuid
260       Sets the hostname to an unique identifier. This is meant for setups
261       where each client may migrate to another physical host, possibly going
262       through one or more name changes in the process.
263
264   * Performance: Since collectd is running as a daemon it doesn't spend much
265     time starting up again and again. With the exception of the exec plugin no
266     processes are forked. Caching in output plugins, such as the rrdtool and
267     network plugins, makes sure your resources are used efficiently. Also,
268     since collectd is programmed multithreaded it benefits from hyperthreading
269     and multicore processors and makes sure that the daemon isn't idle if only
270     one plugins waits for an IO-operation to complete.
271     
272   * Once set up, hardly any maintenance is necessary. Setup is kept as easy
273     as possible and the default values should be okay for most users.
274
275
276 Operation
277 ---------
278
279   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
280     Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
281     for a list of options and a syntax description.
282
283   * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
284     files. The usual place for these files is beneath `/var/lib/collectd'.
285
286   * When using some of the plugins, collectd needs to run as user root, since
287     only root can do certain things, such as craft ICMP packages needed to ping
288     other hosts. collectd should NOT be installed setuid root since it can be
289     used to overwrite valuable files!
290
291   * Sample scripts to generate graphs reside in `contrib/' in the source
292     package or somewhere near `/usr/share/doc/collectd' in most distributions.
293     Please be aware that those script are meant as a starting point for your
294     own experiments.. Some of them require the `RRDs' Perl module.
295     (`librrds-perl' on Debian) If you have written a more sophisticated
296     solution please share it with us.
297
298   * The RRAs of the automatically created RRD files depend on the `step'
299     and `heartbeat' settings given. If change these settings you may need to
300     re-create the files, losing all data. Please be aware of that when changing
301     the values and read the rrdtool(1) manpage thoroughly.
302
303
304 collectd and chkrootkit
305 -----------------------
306
307   If you are using the `dns' plugin chkrootkit(1) will report collectd as a
308   packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
309   plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
310   this case, collectd is a legitimate sniffer and the report should be
311   considered to be a false positive. However, you might want to check that
312   this really is collectd and not some other, illegitimate sniffer.
313
314
315 Prerequisites
316 -------------
317
318   To compile collectd from source you will need:
319
320   * Usual suspects: C compiler, linker, preprocessor, make, ...
321
322   * A POSIX-threads (pthread) implementation.
323     Since gathering some statistics is slow (network connections, slow devices,
324     etc) the collectd is parallelized. The POSIX threads interface is being
325     used and should be found in various implementations for hopefully all
326     platforms.
327
328   * CoreFoundation.framework and IOKit.framework (optional)
329     For compiling on Darwin in general and the `apple_sensors' plugin in
330     particular.
331
332   * libcurl (optional)
333     If you want to use the `apache', `ascent', or `nginx' plugin.
334
335   * libesmtp (optional)
336     For the `notify_email' plugin.
337
338   * libhal (optional)
339     If present, the uuid plugin will check for UUID from HAL.
340
341   * libiptc (optional)
342     For querying iptables counters.
343
344   * libmysqlclient (optional)
345     Unsurprisingly used by the `mysql' plugin.
346
347   * libnetlink (optional)
348     Used, obviously, for the `netlink' plugin.
349
350   * libnetsnmp (optional)
351     For the `snmp' plugin.
352
353   * libnotify (optional)
354     For the `notify_desktop' plugin.
355
356   * liboping (optional, if not found a version shipped with this distribution
357     can be used)
358     Used by the `ping' plugin to send and receive ICMP packets.
359
360   * libpcap (optional)
361     Used to capture packets by the `dns' plugin.
362
363   * libperl (optional)
364     Obviously used by the `perl' plugin. The library has to be compiled with
365     ithread support (introduced in Perl 5.6.0).
366
367   * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
368     If built without `librrd' the resulting binary will be `client only', i.e.
369     will send its values via multicast and not create any RRD files itself.
370     Alternatively you can chose to write CSV-files (Comma Separated Values)
371     instead.
372
373   * librt, libsocket, libkstat, libdevinfo (optional)
374     Various standard Solaris libraries which provide system functions.
375
376   * libsensors (optional)
377     To read from `lm_sensors', see the `sensors' plugin.
378
379   * libstatgrab (optional) may be used to collect statistics on systems other
380     than Linux and/or Solaris. Note that CPU- and disk-statistics, while being
381     provided by this library, are not supported in collectd right now..
382     <http://www.i-scream.org/libstatgrab/> 
383
384   * libupsclient/nut (optional)
385     For the `nut' plugin which queries nut's `upsd'.
386
387   * libvirt (optional)
388     Collect statistics from virtual machines.
389
390   * libxml2 (optional)
391     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
392
393   * libxmms (optional)
394
395
396 Configuring / Compiling / Installing
397 ------------------------------------
398
399   To configure, build and install collectd with the default settings, run
400   `./configure && make && make install'.  For detailed, generic instructions
401   see INSTALL. For a complete list of configure options and their description,
402   run `./configure --help'.
403   
404   By default, the configure script will check for all build dependencies and
405   disable all plugins whose requirements cannot be fulfilled (any other plugin
406   will be enabled). To enable a plugin, install missing dependencies (see
407   section `Prerequisites' above) and rerun `configure'. If you specify the
408   `--enable-<plugin>' configure option, you can force the plugin to be built.
409   This will most likely fail though unless you're working in a very unusual
410   setup and you really know what you're doing.
411
412   By default, collectd will be installed into `/opt/collectd'. You can adjust
413   this setting by specifying the `--prefix' configure option - see INSTALL for
414   details. If you pass DESTDIR=<path> to `make install', <path> will be
415   prefixed to all installation directories. This might be useful when creating
416   packages for collectd.
417
418
419 Crosscompiling
420 --------------
421
422   To compile correctly collectd needs to be able to initialize static
423   variables to NAN (Not A Number). Some C libraries, especially the GNU
424   libc, have a problem with that.
425
426   Luckily, with GCC it's possible to work around that problem: One can define
427   NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
428   ``implementation'' the configure script needs to compile and run a short
429   test program. Obviously running a test program when doing a cross-
430   compilation is, well, challenging.
431
432   If you run into this problem, you can use the `--with-nan-emulation'
433   configure option to force the use of this implementation. We can't promise
434   that the compiled binary actually behaves as it should, but since NANs
435   are likely never passed to the libm you have a good chance to be lucky.
436
437
438 Contact
439 -------
440
441   For questions, bugreports, development information and basically all other
442   concerns please send an email to collectd's mailinglist at
443   <collectd at verplant.org>.
444
445   For live discussion and more personal contact visit us in IRC, we're in
446   channel #collectd on freenode.
447
448
449 Author
450 ------
451
452   Florian octo Forster <octo at verplant.org>,
453   Sebastian tokkee Harl <sh at tokkee.org>,
454   and many contributors (see `AUTHORS').
455
456   Please send bugreports and patches to the mailinglist, see `Contact' above.
457