X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=4a09fee565581e9a26e96d8208200c18897c7939;hb=refs%2Fheads%2Fcollectd-3.11;hp=3da2aaff1f74e01960a7789640803cf004ad9f0d;hpb=407342ee25b7b6e4efefe7c7ee3b74d32f277c45;p=collectd.git diff --git a/README b/README index 3da2aaff..4a09fee5 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ collectd - System information collection daemon ================================================= -http://verplant.org/collectd/ +http://collectd.org/ About ----- @@ -14,35 +14,73 @@ Features * 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) - CPU frequency (For laptops with speed step or a similar technology) + - Mountpoint usage + (Basically the values `df(1)' delivers) + - 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) + - Harddisk temperatures (Uhm, yeah, temperature of harddisks that is ;) - 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, 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) + - Ping latency (Time to reach the default gateway or another given host) - - Serial - (RX and TX of serial interfaces) + - Process counts + (Number of running, sleeping, zombie, ... processes) - Sensors - (System temperatured and fan rotation speeds) + (lm_sensors voltages, temperatures and fan rotation speeds) + + - Serial + (RX and TX of serial interfaces) - Swap (Pages swapped out onto harddisk or whatever is called `swap' by the OS..) @@ -53,6 +91,15 @@ Features - Traffic (In/Outbound traffic on the interfaces) + - Users + (Currently logged in users) + + - VServer + (System ressources used by vservers) + + - Wireless + (Link quality of wireless cards) + * 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. @@ -65,12 +112,17 @@ Features Operation --------- + * collectd's configuration file can be found at `sysconfdir'/collectd.conf. + 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'. - * collectd needs to run as user root, since only root can craft ICMP - packages needed to ping other hosts. collectd should NOT be installed - setui root since it can be used to overwrite valuable files.. + * 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.. * Sample scripts to generate graphs reside in `contrib/' in the source package or somewhere near `/usr/share/doc/collectd' in most distributions. @@ -78,17 +130,9 @@ Operation 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 - - * Use `-c' to start in client-, `-s' to start in server-mode. Read the - manpage for details. + * The RRAs of the automatically created RRD files depend on the `step' + and `heartbeat' settings given on compile time. For a list of the + default RRAs take a look in the collectd(1) manpage. Prerequisites @@ -98,17 +142,35 @@ Prerequisites * Usual suspects: C compiler, linker, preprocessor, make, ... - * rrdtool (headers and library; rrdtool 1.0 and 1.2 both work fine) + * rrdtool (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. + + * libmysqlclient (optional) * lm-sensors (optional) * 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.. + * libcurl (optional) + If you want to use the `apache' plugin + + * librt, libsocket, libkstat, libdevinfo + Various standard Solaris libraries which provide system functions. + + * libpthread (optional) + For parallelization, especially for plugins that communicate with the + outside, e. g. with a socket. + + * CoreFoundation.framework and IOKit.framework + For copiling on darwin in general and the `apple_sensors' plugin in + particular. + Author ------