Added first version of ACPI support to the battery plugin

[collectd.git] / src / collectd.pod

diff --git a/src/collectd.pod b/src/collectd.pod
index 55a99edc2a6e0dd0e2530deb8d4c0c589e1fdbdd..d926017bbb6d1cbdae48793587d52c3bd46e9f44 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -20,6 +20,10 @@ CPU utilization (I<cpu>)
 
 =item
 
+Mountpoint usage (I<df>)
+
+=item
+
 Disk and partition usage/throughput (I<disk>)
 
 =item
@@ -36,6 +40,10 @@ Memory usage (I<memory>)
 
 =item
 
+MySQL statistics (I<mysql>)
+
+=item
+
 NFS utilization (I<nfs>, Linux only)
 
 =item
@@ -76,20 +84,11 @@ Number of users logged into the system (I<users>)
 
 =over 4
 
-=item B<-c>
+=item B<-C> I<E<lt>config-fileE<gt>>
 
-Start in client (transmitter) mode. Data will be sent to the multicast group.
-See L<"MODES">.
-
-=item B<-d> I<E<lt>directoryE<gt>>
-
-Sets the directory collectd should work in. All F<.rrd>-files are created in
-this directory. Per default this is F</var/lib/collectd/>.
-
-=item B<-P> I<E<lt>directoryE<gt>>
-
-Sets the directory collectd should look for plugins in. Per default this is
-F</usr/lib/collectd>.
+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<-f>
 
@@ -101,23 +100,6 @@ thought for 'supervisioning' init replacements such as I<runit>.
 
 Output usage information and exit.
 
-=item B<-l>
-
-Start in local mode. This is the default. No data will be sent or read to/from
-the network. Information will be read and written by the same process. See
-L<"MODES">.
-
-=item B<-p> I<E<lt>hostE<gt>>
-
-Sets the host to ping periodically. This option may be given more than once to
-ping multiple hosts. If this option is not given at least once no host will be
-pinged.
-
-=item B<-s>
-
-Start in server (receiver) mode. Data sent to the multicast group will be read
-and stored in RRD files. See L<"MODES">.
-
 =back
 
 =head1 RRD FILES
@@ -155,6 +137,11 @@ The DS'es depend on the module creating the RRD files:
   DS:idle:COUNTER:25:0:100
   DS:wait:COUNTER:25:0:100
 
+=item Mountpoints (F<df-I<E<lt>pathE<gt>>.rrd>)
+
+  DS:used:GAUGE:25:0:U
+  DS:free:GAUGE:25:0:U
+
 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
   DS:rcount:COUNTER:25:0:U
@@ -190,6 +177,10 @@ The DS'es depend on the module creating the RRD files:
   DS:buffers:GAUGE:25:0:9223372036854775807
   DS:cached:GAUGE:25:0:9223372036854775807
 
+=item MySQL statistics (F<mysql_commands-I<E<lt>commandE<gt>>.rrd> and F<mysql_handler-I<E<lt>handlerE<gt>>.rrd>)
+
+  DS:value:COUNTER:25:0:U
+
 =item NFSv2 Procedures (F<nfs2_procedures-I<(client|server)>.rrd>)
 
   DS:null:COUNTER:25:0:U
@@ -324,7 +315,7 @@ 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.
 
-=head1 SPECIAL MODULES
+=head1 SPECIAL PLUGINS
 
 =head2 cpufreq
 
@@ -333,6 +324,19 @@ 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.
 
+=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>. 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
@@ -354,7 +358,8 @@ L<http://www.guzu.net/linux/hddtemp.php>.
 
 =head1 SEE ALSO
 
-L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>, L<kstat(3KSTAT)>
+L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
+L<kstat(3KSTAT)>
 
 =head1 AUTHOR