![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 18fcf0a4ac89146b761d7a18afe5dd9dd97b1127..8d6c7edb4c07b5ce4db4457918c36702415f2652 100644 (file)
--- a/README
+++ b/README
collectd - System information collection daemon
=================================================
-http://verplant.org/collectd/
+http://collectd.org/
About
-----
* collectd is able to collect the following data:
+ - Apache server utilization
+ (Number of bytes transfered, number of requests handled and detailed
+ scoreboard statistics)
+
+ - APC UPS Daemon
+ (UPS charge, load, input/output/battery voltage, etc)
+
+ - Apple Sensors
+ (Temperature, fanspeed and voltage sensors of apple computers)
+
+ - Battery
+ (Charge, current and charge of ACPI and PMU based batteries)
+
- CPU utilization
(Time spent in system, user, nice and idle)
- Disk utilization
(Sectors read/written, number of read/write actions, time spent doing IO)
+ - DNS traffic
+ (query types, response codes, opcodes and traffic)
+
+ - Email statistics
+ (count, traffic, spam scores and checks)
+
+ - Entropy available
+ (Amount of entropy available to the system)
+
+ - Exec
+ (Values gatheres by a custom program or script)
+
- Harddisk temperatures
(Uhm, yeah, temperature of harddisks that is ;)
+ - Interface traffic
+ (Number of octets, packets and errors for each interface)
+
+ - Iptables' counters
+ (Number of bytes that were matched by a certain iptables rule)
+
+ - IRQ counters
+ (Frequency in which certain interrupts occur)
+
- System load
(Load average over the last 1, 5 and 15 minutes)
+ - mbmon - motherboard monitoring
+ (temperature, fanspeed and voltage information)
+
- Memory utilization
(Memory occupied by running processes, page cache, buffer cache and free)
+ - Multimeter
+ (Information provided by serial multimeters, such as the «Metex M-4650CR»)
+
- MySQL server statistics
- (Commands issued, handlers triggered and traffic sent/received)
+ (Commands issued, handlers triggered, thread usage, query cache
+ utilization and traffic sent/received)
- NFS Procedures
(Which NFS command were called how often. Only NFSv2 and NFSv3 right now)
+ - NTP Daemon
+ (Local clock drift, offset to peers, etc)
+
+ - Network UPS tools
+ (UPS current, voltage, power, charge, utilisation, temperature, etc.)
+
- Ping latency
(Time to reach the default gateway or another given host)
- Process counts
(Number of running, sleeping, zombie, ... processes)
+ - Sensors
+ (lm_sensors voltages, temperatures and fan rotation speeds)
+
- Serial
(RX and TX of serial interfaces)
- - Sensors
- (System temperatured and fan rotation speeds)
-
- Swap
(Pages swapped out onto harddisk or whatever is called `swap' by the OS..)
- Tape
(Read and write bytes and operations on tape devices)
- - Traffic
- (In/Outbound traffic on the interfaces)
-
- Users
(Currently logged in users)
+ - VServer
+ (System ressources used by vservers)
+
+ - Wireless
+ (Link quality of wireless cards)
+
+ * Output to CSV- and RRD-files, send values over the network and/or provide a
+ generic interface for use by other means, e. g. a Nagios-plugin.
+
* Performance: Running as a daemon collectd doesn't spend much time in
startup. Since collectd links against libping, librrd and libsensors it
doesn't need to start any other processes.
Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
for a list of options and a syntax description.
- * When running collectd writes system statistics in RRD-files. Per default
- they reside in `/var/lib/collectd'.
+ * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
+ files. The usual place for these files is beneath `/var/lib/collectd'.
- * When using the `ping' plugin collectd needs to run as user root, since only
- root can craft ICMP packages needed to ping other hosts. collectd should
- NOT be installed setuid root since it can be used to overwrite valuable
- files..
+ * When using some of the plugins, collectd needs to run as user root, since only
+ root can do certain thing, such as craft ICMP packages needed to ping other
+ hosts. collectd should NOT be installed setuid root since it can be used to
+ overwrite valuable files..
* Sample scripts to generate graphs reside in `contrib/' in the source
package or somewhere near `/usr/share/doc/collectd' in most distributions.
own experiments.. Some of them require the `RRDs' Perl module.
(`librrds-perl' on Debian)
- * The RRD-files that collectd creates hold the following data. Use ``rrdtool
- resize'' if you want to cover longer/shorter periods of time.
-
- Resolution | Data points | Timespan
- -----------+-------------+----------
- 60 seconds | 1500 | 25 hours
- 30 minutes | 1680 | 35 days
- 6 hours | 1520 | 380 days
+ * The RRAs of the automatically created RRD files depend on the `step'
+ and `heartbeat' settings given. For a list of the default RRAs take a look
+ in the collectd(1) manpage.
Prerequisites
* Usual suspects: C compiler, linker, preprocessor, make, ...
- * rrdtool (headers and library; rrdtool 1.0 and 1.2 both work fine)
- If built without `librrd' the resulting binary will be `client only', i.e.
- will send it's values via multicast and not create any RRD files itself.
+ * A POSIX-threads (pthread) implementation.
+ Since gathering some statistics is slow (network connections, slow devices,
+ etc) the collectd is parellelized. The POSIX threads interface is being
+ used and should be found in various implementations for hopefully all
+ platforms.
+
+ * libcurl (optional)
+ If you want to use the `apache' plugin
+
+ * libiptc (optional)
+ For querying iptables counters.
* libmysqlclient (optional)
- * lm-sensors (optional)
+ * liboping (optional, if not found a version shipped with this distribution
+ can be used)
+ Used by the `ping' plugin to send and receive ICMP packets.
+
+ * libpcap (optional)
+ Used to capture packets by the `dns' plugin.
+
+ * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
+ If built without `librrd' the resulting binary will be `client only', i.e.
+ will send it's values via multicast and not create any RRD files itself.
+ Alternatively you can chose to write CSV-files (Comma Seperated Values)
+ instead.
+
+ * libsensors (optional)
+ To read from `lm_sensors'.
* libstatgrab may be used to collect statistics on systems other than Linux
- and/or Solaris. Note that CPU- and disk-statistics, while being provided by
- this library, are not supported in collectd right now..
+ and/or Solaris. Note that CPU- and disk-statistics, while being provided
+ by this library, are not supported in collectd right now..
<http://www.i-scream.org/libstatgrab/>
+ * libupsclient/nut (optional)
+ For the `nut' plugin which queries nut's `upsd'.
+
+ * librt, libsocket, libkstat, libdevinfo
+ Various standard Solaris libraries which provide system functions.
+
+ * CoreFoundation.framework and IOKit.framework
+ For compiling on darwin in general and the `apple_sensors' plugin in
+ particular.
+
Author
------