X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.pod;h=5bd827844dea874a4c59f6fb98ba65854fa0d8e0;hb=d1dfc7fda0fedac212cbd320ba78ef2c217f912d;hp=515cba6a5e5713eb3f795124e96e607d29a177a8;hpb=8aa04ef8a93f1183c3ffaf9b482cdd57a2084410;p=collectd.git

diff --git a/src/collectd.pod b/src/collectd.pod
index 515cba6a..5bd82784 100644
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -16,10 +16,26 @@ settings. The following features may be available:
 
 =item
 
+Apache server stats (I<apache>)
+
+=item
+
+Apple hardware sensors (I<apple_sensors>, Darwin only)
+
+=item
+
+Battery status (I<battery>)
+
+=item
+
 CPU utilization (I<cpu>)
 
 =item
 
+Mountpoint usage (I<df>)
+
+=item
+
 Disk and partition usage/throughput (I<disk>)
 
 =item
@@ -36,6 +52,10 @@ Memory usage (I<memory>)
 
 =item
 
+MySQL statistics (I<mysql>)
+
+=item
+
 NFS utilization (I<nfs>, Linux only)
 
 =item
@@ -70,6 +90,14 @@ Network traffic (I<traffic>)
 
 Number of users logged into the system (I<users>)
 
+=item
+
+System ressources used by VServers (I<vserver>)
+
+=item
+
+Wireless network stats (I<wireless>)
+
 =back
 
 =head1 OPTIONS
@@ -82,6 +110,13 @@ Specify an alternative config file. This is the place to go when you wish to
 change B<collectd>'s behavior. The path may be relative to the current working
 directory.
 
+=item B<-P> I<E<lt>pid-fileE<gt>>
+
+Specify an alternative pid file. This overwrites any settings in the config 
+file. This is thought for init-scripts that require the PID-file in a certain
+directory to work correctly. For everyday-usage use the B<PIDFile>
+config-option.
+
 =item B<-f>
 
 Don't fork to the background. I<collectd> will also B<not> close standard file
@@ -94,237 +129,389 @@ Output usage information and exit.
 
 =back
 
-=head1 RRD FILES
+=head1 MODES
+
+collectd can operate in four different operating modes. The modes are described
+below.
+
+The simplest mode is the so called B<local mode>. Data is collected locally and
+written in RRD files that reside in I<DataDir>. This is the default mode when
+collectd is linked against C<librrd>.
+
+The modes B<client mode> and B<server mode> are used to send data over a
+network and receive it again.
+
+In B<client mode> the daemon collects the data locally and sends its results
+to one or more network addresses. No RRD files are written locally in this
+case. If collectd is not linked against C<librrd> this is the default mode.
+
+If started in B<server mode> the daemon will listen on one or more interfaces
+and write the data it receives to RRD files. No data is collected locally.
+
+In the last mode, B<log mode>, data is collected locally and written in
+text files that reside in I<DataDir>.
+
+Please refer to L<collectd.conf(5)> for the configuration options and default
+values.
+
+=head1 SPECIAL PLUGINS
+
+=head2 apache
+
+This module connects to an Apache webserver and expects the output produced by
+B<mod_status.c>. If requires B<libcurl> to set up the HTTP connection and issue
+the request(s). The following is a sample config for the Apache webserver. The
+use of C<ExtendedStatus on> is mandatory.
+
+  ExtendedStatus on
+  <IfModule mod_status.c>
+    <Location /mod_status>
+      SetHandler server-status
+    </Location>
+  </IfModule>
+
+This plugin requires further configuration. Please read L<collectd.conf(5)>.
+
+=head2 cpufreq
+
+This module reads F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for
+the first CPU installed) to get the current CPU frequency. If this file does
+not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
+similar tool is installed and an "cpu governor" (that's kernel module) is
+loaded.
+
+=head2 mysql
+
+Requires B<mysqlclient> to be installed. It connects to the database when
+started and keeps the connection up as long as possible. When the connection is
+interrupted for whatever reason it will try to re-connect. The syslog will
+contain loud complaints in case anything goes wrong.
+
+This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
+C<Com_*> and C<Handler_*> which correspond to F<traffic-mysql.rrd>,
+F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
+C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
+in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
+I<5.2.4. Server Status Variables> for an explanation of these values.
+
+=head2 sensors
+
+The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
+that all the needed modules have to be loaded and lm_sensors has to be
+configured (most likely by editing F</etc/sensors.conf>. Read
+L<sensors.conf(5)> for details.
+
+The B<lm_sensors> homepage can be found at
+L<http://secure.netroedge.com/~lm78/>.
+
+=head2 hddtemp
 
-The RRD files are created automatically with the following RRAs:
+To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
+port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
+default values. See L<collectd.conf(5)> for details. C<hddtemp> has to be
+running to work correctly. If C<hddtemp> is not running timeouts may appear
+which may interfere with other statistics..
+
+The B<hddtemp> homepage can be found at
+L<http://www.guzu.net/linux/hddtemp.php>.
 
-  RRA:AVERAGE:0.2:6:1500
-  RRA:AVERAGE:0.1:180:1680
-  RRA:AVERAGE:0.1:2160:1520
-  RRA:MIN:0.2:6:1500
-  RRA:MIN:0.1:180:1680
-  RRA:MIN:0.1:2160:1520
-  RRA:MAX:0.2:6:1500
-  RRA:MAX:0.1:180:1680
-  RRA:MAX:0.1:2160:1520
+=head2 vserver
 
-Since collectd uses a 10 second I<step> the RRAs contain the following
-timespans:
+B<VServer> support is only available for Linux. It cannot yet be found in a 
+vanilla kernel, though. To make use of this plugin you need a kernel that has 
+B<VServer> support built in, i.e. you need to apply the patches and compile 
+your own kernel, which will then provide the /proc/virtual filesystem that is
+required by this plugin.
 
-  Resolution | Data points |  Timespan
-  -----------+-------------+----------
-  60 seconds |        1500 |  25 hours
-  30 minutes |        1680 |  35 days
-   6 hours   |        1520 | 380 days
+The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
+
+=head1 RRD FILES
+
+The RRD files are created automatically. The size of the RRAs depend on the
+compile time settings of I<step> and I<width>. With the default values (I<step>
+= B<10>, I<width> = B<1200>) the following RRAs are created:
+
+  RRA:AVERAGE:0.1:1:8640
+  RRA:AVERAGE:0.1:50:1210
+  RRA:AVERAGE:0.1:223:1202
+  RRA:AVERAGE:0.1:2635:1201
+  RRA:MIN:0.1:1:8640
+  RRA:MIN:0.1:50:1210
+  RRA:MIN:0.1:223:1202
+  RRA:MIN:0.1:2635:1201
+  RRA:MAX:0.1:1:8640
+  RRA:MAX:0.1:50:1210
+  RRA:MAX:0.1:223:1202
+  RRA:MAX:0.1:2635:1201
+
+By default collectd uses a 10 second I<step>. Thus the RRAs contain the
+following timespans. If you've changed the I<step> at compile time you will
+have calculate resolution and timespan yourself.
+
+  PDP per CDP |  Resolution  | Data points | Timespan
+  ------------+--------------+-------------+---------
+            1 | 10.0 seconds !        8640 ! 1 day
+           50 |  8.3 minutes |        1210 | 1 week
+          223 | 37.2 minutes |        1202 | 1 month
+         2635 |  7.3 hours   |        1201 | 1 year
 
 The DS'es depend on the module creating the RRD files:
 
 =over 4
 
+=item Apache traffic (F<apache/apache_bytes.rrd>)
+
+  DS:count:COUNTER:HEARTBEAT:0:134217728
+
+=item Apache requests (F<apache/apache_requests.rrd>)
+
+  DS:count:COUNTER:HEARTBEAT:0:1048576
+
+=item Apache scoreboard (F<apache/apache_scoreboard-I<E<lt>nameE<gt>>.rrd>)
+
+  DS:count:GAUGE:HEARTBEAT:0:U
+
+=item Apple temperature sensor (F<apple_sensors/temperature-I<E<lt>nameE<gt>>.rrd>)
+
+  DS:value:GAUGE:HEARTBEAT:U:U
+
+=item Apple fanspeed sensor (F<apple_sensors/fanspeed-I<E<lt>nameE<gt>>.rrd>)
+
+  DS:value:GAUGE:HEARTBEAT:U:U
+
+=item Battery charge (F<battery-I<E<lt>nameE<gt>>/charge.rrd>)
+
+  DS:charge:GAUGE:HEARTBEAT:0:U
+
+=item Battery current (F<battery-I<E<lt>nameE<gt>>/current.rrd>)
+
+  DS:current:GAUGE:HEARTBEAT:U:U
+
+=item Battery voltage (F<battery-I<E<lt>nameE<gt>>/voltage.rrd>)
+
+  DS:voltage:GAUGE:HEARTBEAT:U:U
+
 =item CPU (F<cpu-I<E<lt>numE<gt>>.rrd>)
 
-  DS:user:COUNTER:25:0:100
-  DS:nice:COUNTER:25:0:100
-  DS:syst:COUNTER:25:0:100
-  DS:idle:COUNTER:25:0:100
-  DS:wait:COUNTER:25:0:100
+  DS:user:COUNTER:HEARTBEAT:0:100
+  DS:nice:COUNTER:HEARTBEAT:0:100
+  DS:syst:COUNTER:HEARTBEAT:0:100
+  DS:idle:COUNTER:HEARTBEAT:0:100
+  DS:wait:COUNTER:HEARTBEAT:0:100
+
+=item CPU frequency (F<cpufreq-I<E<lt>numE<gt>>.rrd>)
+
+  DS:value:GAUGE:HEARTBEAT:0:U
+
+=item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
+
+  DS:used:GAUGE:HEARTBEAT:0:U
+  DS:free:GAUGE:HEARTBEAT:0:U
 
 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
-  DS:rcount:COUNTER:25:0:U
-  DS:rmerged:COUNTER:25:0:U
-  DS:rbytes:COUNTER:25:0:U
-  DS:rtime:COUNTER:25:0:U
-  DS:wcount:COUNTER:25:0:U
-  DS:wmerged:COUNTER:25:0:U
-  DS:wbytes:COUNTER:25:0:U
-  DS:wtime:COUNTER:25:0:U
+  DS:rcount:COUNTER:HEARTBEAT:0:U
+  DS:rmerged:COUNTER:HEARTBEAT:0:U
+  DS:rbytes:COUNTER:HEARTBEAT:0:U
+  DS:rtime:COUNTER:HEARTBEAT:0:U
+  DS:wcount:COUNTER:HEARTBEAT:0:U
+  DS:wmerged:COUNTER:HEARTBEAT:0:U
+  DS:wbytes:COUNTER:HEARTBEAT:0:U
+  DS:wtime:COUNTER:HEARTBEAT:0:U
 
 =item Diskstats (F<partition-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
-  DS:rcount:COUNTER:25:0:U
-  DS:rbytes:COUNTER:25:0:U
-  DS:wcount:COUNTER:25:0:U
-  DS:wbytes:COUNTER:25:0:U
+  DS:rcount:COUNTER:HEARTBEAT:0:U
+  DS:rbytes:COUNTER:HEARTBEAT:0:U
+  DS:wcount:COUNTER:HEARTBEAT:0:U
+  DS:wbytes:COUNTER:HEARTBEAT:0:U
 
 =item HDD Temperature (F<hddtemp-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
-  DS:value:GAUGE:25:U:U
+  DS:value:GAUGE:HEARTBEAT:U:U
 
 =item System load (F<load.rrd>)
 
-  DS:shortterm:GAUGE:25:0:100
-  DS:midterm:GAUGE:25:0:100
-  DS:longterm:GAUGE:25:0:100
+  DS:shortterm:GAUGE:HEARTBEAT:0:100
+  DS:midterm:GAUGE:HEARTBEAT:0:100
+  DS:longterm:GAUGE:HEARTBEAT:0:100
 
 =item Memory usage (F<memory.rrd>)
 
-  DS:used:GAUGE:25:0:9223372036854775807
-  DS:free:GAUGE:25:0:9223372036854775807
-  DS:buffers:GAUGE:25:0:9223372036854775807
-  DS:cached:GAUGE:25:0:9223372036854775807
+  DS:used:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:free:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:buffers:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:cached:GAUGE:HEARTBEAT:0:9223372036854775807
+
+=item MySQL commands and handlers (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
+
+  DS:value:COUNTER:HEARTBEAT:0:U
+
+=item MySQL query cache (F<mysql_qcache.rrd>)
+
+  DS:hits:COUNTER:HEARTBEAT:0:U
+  DS:inserts:COUNTER:HEARTBEAT:0:U
+  DS:not_cached:COUNTER:HEARTBEAT:0:U
+  DS:lowmem_prunes:COUNTER:HEARTBEAT:0:U
+  DS:queries_in_cache:GAUGE:HEARTBEAT:0:U
+
+=item MySQL threads (F<mysql_threads.rrd>)
+
+  DS:running:GAUGE:HEARTBEAT:0:U
+  DS:connected:GAUGE:HEARTBEAT:0:U
+  DS:cached:GAUGE:HEARTBEAT:0:U
+  DS:created:COUNTER:HEARTBEAT:0:U
 
 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
 
-  DS:null:COUNTER:25:0:U
-  DS:getattr:COUNTER:25:0:U
-  DS:setattr:COUNTER:25:0:U
-  DS:root:COUNTER:25:0:U
-  DS:lookup:COUNTER:25:0:U
-  DS:readlink:COUNTER:25:0:U
-  DS:read:COUNTER:25:0:U
-  DS:wrcache:COUNTER:25:0:U
-  DS:write:COUNTER:25:0:U
-  DS:create:COUNTER:25:0:U
-  DS:remove:COUNTER:25:0:U
-  DS:rename:COUNTER:25:0:U
-  DS:link:COUNTER:25:0:U
-  DS:symlink:COUNTER:25:0:U
-  DS:mkdir:COUNTER:25:0:U
-  DS:rmdir:COUNTER:25:0:U
-  DS:readdir:COUNTER:25:0:U
-  DS:fsstat:COUNTER:25:0:U
+  DS:null:COUNTER:HEARTBEAT:0:U
+  DS:getattr:COUNTER:HEARTBEAT:0:U
+  DS:setattr:COUNTER:HEARTBEAT:0:U
+  DS:root:COUNTER:HEARTBEAT:0:U
+  DS:lookup:COUNTER:HEARTBEAT:0:U
+  DS:readlink:COUNTER:HEARTBEAT:0:U
+  DS:read:COUNTER:HEARTBEAT:0:U
+  DS:wrcache:COUNTER:HEARTBEAT:0:U
+  DS:write:COUNTER:HEARTBEAT:0:U
+  DS:create:COUNTER:HEARTBEAT:0:U
+  DS:remove:COUNTER:HEARTBEAT:0:U
+  DS:rename:COUNTER:HEARTBEAT:0:U
+  DS:link:COUNTER:HEARTBEAT:0:U
+  DS:symlink:COUNTER:HEARTBEAT:0:U
+  DS:mkdir:COUNTER:HEARTBEAT:0:U
+  DS:rmdir:COUNTER:HEARTBEAT:0:U
+  DS:readdir:COUNTER:HEARTBEAT:0:U
+  DS:fsstat:COUNTER:HEARTBEAT:0:U
 
 =item NFSv3 Procedures (F<nfs3_procedures-I<(client|server)>.rrd>)
 
-  DS:null:COUNTER:25:0:U
-  DS:getattr:COUNTER:25:0:U
-  DS:setattr:COUNTER:25:0:U
-  DS:lookup:COUNTER:25:0:U
-  DS:access:COUNTER:25:0:U
-  DS:readlink:COUNTER:25:0:U
-  DS:read:COUNTER:25:0:U
-  DS:write:COUNTER:25:0:U
-  DS:create:COUNTER:25:0:U
-  DS:mkdir:COUNTER:25:0:U
-  DS:symlink:COUNTER:25:0:U
-  DS:mknod:COUNTER:25:0:U
-  DS:remove:COUNTER:25:0:U
-  DS:rmdir:COUNTER:25:0:U
-  DS:rename:COUNTER:25:0:U
-  DS:link:COUNTER:25:0:U
-  DS:readdir:COUNTER:25:0:U
-  DS:readdirplus:COUNTER:25:0:U
-  DS:fsstat:COUNTER:25:0:U
-  DS:fsinfo:COUNTER:25:0:U
-  DS:pathconf:COUNTER:25:0:U
-  DS:commit:COUNTER:25:0:U
+  DS:null:COUNTER:HEARTBEAT:0:U
+  DS:getattr:COUNTER:HEARTBEAT:0:U
+  DS:setattr:COUNTER:HEARTBEAT:0:U
+  DS:lookup:COUNTER:HEARTBEAT:0:U
+  DS:access:COUNTER:HEARTBEAT:0:U
+  DS:readlink:COUNTER:HEARTBEAT:0:U
+  DS:read:COUNTER:HEARTBEAT:0:U
+  DS:write:COUNTER:HEARTBEAT:0:U
+  DS:create:COUNTER:HEARTBEAT:0:U
+  DS:mkdir:COUNTER:HEARTBEAT:0:U
+  DS:symlink:COUNTER:HEARTBEAT:0:U
+  DS:mknod:COUNTER:HEARTBEAT:0:U
+  DS:remove:COUNTER:HEARTBEAT:0:U
+  DS:rmdir:COUNTER:HEARTBEAT:0:U
+  DS:rename:COUNTER:HEARTBEAT:0:U
+  DS:link:COUNTER:HEARTBEAT:0:U
+  DS:readdir:COUNTER:HEARTBEAT:0:U
+  DS:readdirplus:COUNTER:HEARTBEAT:0:U
+  DS:fsstat:COUNTER:HEARTBEAT:0:U
+  DS:fsinfo:COUNTER:HEARTBEAT:0:U
+  DS:pathconf:COUNTER:HEARTBEAT:0:U
+  DS:commit:COUNTER:HEARTBEAT:0:U
 
 =item Network latency / Ping (F<ping-I<E<lt>hostnameE<gt>>.rrd>)
 
-  DS:ping:GAUGE:25:0:65535
+  DS:ping:GAUGE:HEARTBEAT:0:65535
 
 =item Processes (F<processes.rrd>)
 
-  DS:running:GAUGE:25:0:65535
-  DS:sleeping:GAUGE:25:0:65535
-  DS:zombies:GAUGE:25:0:65535
-  DS:stopped:GAUGE:25:0:65535
-  DS:paging:GAUGE:25:0:65535
-  DS:blocked:GAUGE:25:0:65535
+  DS:running:GAUGE:HEARTBEAT:0:65535
+  DS:sleeping:GAUGE:HEARTBEAT:0:65535
+  DS:zombies:GAUGE:HEARTBEAT:0:65535
+  DS:stopped:GAUGE:HEARTBEAT:0:65535
+  DS:paging:GAUGE:HEARTBEAT:0:65535
+  DS:blocked:GAUGE:HEARTBEAT:0:65535
+
+=item lm_sensors fanspeed sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/fanspeed-I<E<lt>instE<gt>>.rrd>)
+
+  DS:value:GAUGE:HEARTBEAT:U:U
+
+=item lm_sensors temperature sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/temperature-I<E<lt>instE<gt>>.rrd>)
 
-=item lm_sensors (F<sensors-I<E<lt>chipE<gt>>-I<E<lt>featureE<gt>>.rrd>)
+  DS:value:GAUGE:HEARTBEAT:U:U
 
-  DS:value:GAUGE:25:U:U
+=item lm_sensors voltage sensor (F<sensors-I<E<lt>instE<gt>>.rrd> or F<lm_sensors-I<E<lt>chipE<gt>>/voltage-I<E<lt>instE<gt>>.rrd>)
+
+  DS:voltage:GAUGE:HEARTBEAT:U:U
 
 =item Serial port traffic (F<serial-I<E<lt>numE<gt>>.rrd>)
 
-  DS:incoming:COUNTER:25:0:U
-  DS:outgoing:COUNTER:25:0:U
+  DS:incoming:COUNTER:HEARTBEAT:0:U
+  DS:outgoing:COUNTER:HEARTBEAT:0:U
 
 =item Swap usage (F<swap.rrd>)
 
-  DS:used:GAUGE:25:0:1099511627776
-  DS:free:GAUGE:25:0:1099511627776
-  DS:cached:GAUGE:25:0:1099511627776
-  DS:resv:GAUGE:25:0:1099511627776
+  DS:used:GAUGE:HEARTBEAT:0:1099511627776
+  DS:free:GAUGE:HEARTBEAT:0:1099511627776
+  DS:cached:GAUGE:HEARTBEAT:0:1099511627776
+  DS:resv:GAUGE:HEARTBEAT:0:1099511627776
 
 =item Tape drive usage (F<tape-I<E<lt>nameE<gt>>.rrd>)
 
-  DS:rcount:COUNTER:25:0:
-  DS:rmerged:COUNTER:25:0:U
-  DS:rbytes:COUNTER:25:0:U
-  DS:rtime:COUNTER:25:0:U
-  DS:wcount:COUNTER:25:0:U
-  DS:wmerged:COUNTER:25:0:U
-  DS:wbytes:COUNTER:25:0:U
-  DS:wtime:COUNTER:25:0:U
+  DS:rcount:COUNTER:HEARTBEAT:0:
+  DS:rmerged:COUNTER:HEARTBEAT:0:U
+  DS:rbytes:COUNTER:HEARTBEAT:0:U
+  DS:rtime:COUNTER:HEARTBEAT:0:U
+  DS:wcount:COUNTER:HEARTBEAT:0:U
+  DS:wmerged:COUNTER:HEARTBEAT:0:U
+  DS:wbytes:COUNTER:HEARTBEAT:0:U
+  DS:wtime:COUNTER:HEARTBEAT:0:U
 
-=item Network traffic (F<traffic-I<E<lt>nameE<gt>>.rrd>)
+=item Network traffic (F<traffic-I<E<lt>interfaceE<gt>>.rrd>)
 
-  DS:incoming:COUNTER:25:0:U
-  DS:outgoing:COUNTER:25:0:U
+  DS:incoming:COUNTER:HEARTBEAT:0:U
+  DS:outgoing:COUNTER:HEARTBEAT:0:U
 
-=item Users (F<users.rrd>)
+=item Interface packets (F<if_packets-I<E<lt>interfaceE<gt>>.rrd>)
 
-  DS:users:GAUGE:25:0:65535
+  DS:rx:COUNTER:HEARTBEAT:0:U
+  DS:tx:COUNTER:HEARTBEAT:0:U
 
-=back
+=item Interface errors (F<if_errors-I<E<lt>interfaceE<gt>>.rrd>)
 
-=head1 MODES
+  DS:rx:COUNTER:HEARTBEAT:0:U
+  DS:tx:COUNTER:HEARTBEAT:0:U
 
-By default collectd starts in the so called I<local mode> which is not very
-interesting. It collects data and writes it into RRD files in
-F</var/lib/collectd>. There's nothing special so I won't discuss that in more
-detail..
-
-Please be aware that B<client-, local- and server-mode are mutual exclusive>. A
-later declaration overrides earlier ones. I<collectd -l -c -s> will start in
-server-mode. If you want statistics of the server too you will have to start a
-client process as well.
+=item Users (F<users.rrd>)
 
-Starting with version 3 collectd may send data over a network. As common with
-network stuff there are two modes: A I<sender> and a I<listener>. Since one
-usually has many senders and only a few listeners the sender is also called
-I<client> (using the option B<-c>) and the listener is called I<server> (using
-the option B<-s>).
+  DS:users:GAUGE:HEARTBEAT:0:65535
 
-Communication happends using the (IPv4) multicast group B<239.192.74.66> and
-packets sent to the port B<25826/udp>. Every ten seconds the I<client> queries
-all the modules and sends the collected data to the multicast group. The
-I<server> subscribes to the multicast group upon startup and then waits for
-incoming packets. As it receives the packets it checks wether it has the
-neccessary module and, if found, writes the data to an RRD file, creating
-directories and files as needed.
+=item VServer load (F<vserver-I<E<lt>xidE<gt>>/load.rrd>)
 
-The multicast group used is within the I<Organization Local Scope> as defined
-by L<RFC2365>. Addresses within that space are meant to be routed within an AS
-but not to the outside. However collectd cannot control this and won't try. So
-it's totally up to you to secure your net.
+  DS:shortterm:GAUGE:HEARTBEAT:0:100
+  DS:midterm:GAUGE:HEARTBEAT:0:100
+  DS:longterm:GAUGE:HEARTBEAT:0:100
 
-The UDP port used has been checked to not be assigned by the IANA.
+=item VServer threads (F<vserver-I<E<lt>xidE<gt>>/threads.rrd>)
 
-On multi-homed machines you may need to add a route to the multicast net
-(B<224.0.0.0/4>) if multicast packages take the wrong interface. The listener
-on the other hand listens on B<all> interfaces.
+  DS:total:GAUGE:HEARTBEAT:0:65535
+  DS:running:GAUGE:HEARTBEAT:0:65535
+  DS:uninterruptible:GAUGE:HEARTBEAT:0:65535
+  DS:onhold:GAUGE:HEARTBEAT:0:65535
 
-=head1 SPECIAL MODULES
+=item VServer network traffic (F<vserver-I<E<lt>xidE<gt>>/traffic-I<E<lt>nameE<gt>>.rrd>)
 
-=head2 cpufreq
+  DS:incoming:COUNTER:HEARTBEAT:0:9223372036854775807
+  DS:outgoing:COUNTER:HEARTBEAT:0:9223372036854775807
+  DS:failed:COUNTER:HEARTBEAT:0:9223372036854775807
 
-This module reads F</sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_cur_freq> (for
-the first CPU installed) to get the current CPU frequency. If this file does
-not exist make sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a
-similar tool is installed.
+=item VServer processes (F<vserver-I<E<lt>xidE<gt>>/vs_processes.rrd>)
 
-=head2 sensors
+  DS:total:GAUGE:HEARTBEAT:0:65535
 
-The B<sensors> module uses lm_sensors to retrieve sensor-values. This means
-that all the needed modules have to be loaded and lm_sensors has to be
-configured (most likely by editing F</etc/sensors.conf>. Read
-L<sensors.conf(5)> for details.
+=item VServer memory usage (F<vserver-I<E<lt>xidE<gt>>/vs_memory.rrd>)
 
-The B<lm_sensors> homepage can be found at
-L<http://secure.netroedge.com/~lm78/>.
+  DS:vm:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:vml:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:rss:GAUGE:HEARTBEAT:0:9223372036854775807
+  DS:anon:GAUGE:HEARTBEAT:0:9223372036854775807
 
-=head2 hddtemp
+=item Wireless link quality (F<wireless-I<E<lt>interfaceE<gt>>.rrd>)
 
-To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
-port B<7634/tcp>. hddtemp has to be running to work correctly. If hddtemp is
-not running timeouts may appear which may interfere with other statistics..
+  DS:quality:GAUGE:HEARTBEAT:0:U
+  DS:power:GAUGE:HEARTBEAT:U:0
+  DS:noise:GAUGE:HEARTBEAT:U:0
 
-The B<hddtemp> homepage can be found at
-L<http://www.guzu.net/linux/hddtemp.php>.
+=back
 
 =head1 SEE ALSO