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