From: Florian Forster <octo@huhu.verplant.org>
Date: Thu, 18 Nov 2010 08:45:22 +0000 (+0100)
Subject: collectd.conf(5): Add documentation for the LPAR plugin.
X-Git-Tag: collectd-5.0.0-beta0~18
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=908956b8c46180d0905478e9c1e110d5213f2808;p=collectd.git

collectd.conf(5): Add documentation for the LPAR plugin.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 1c31d97f..f4f3f1c5 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1750,8 +1750,8 @@ debugging support.
 
 Sets the file to write log messages to. The special strings B<stdout> and
 B<stderr> can be used to write to the standard output and standard error
-channels, respectively. This, of course, only makes much sense when collectd is
-running in foreground- or non-daemon-mode.
+channels, respectively. This, of course, only makes much sense when I<collectd>
+is running in foreground- or non-daemon-mode.
 
 =item B<Timestamp> B<true>|B<false>
 
@@ -1768,6 +1768,33 @@ B<Note>: There is no need to notify the daemon after moving or removing the
 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
 for each line it writes.
 
+=head2 Plugin C<lpar>
+
+The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
+virtualization technique for IBM POWER processors. It takes into account CPU
+time stolen from or donated to a partition, in addition to the usual user,
+system, I/O statistics.
+
+The following configuration options are available:
+
+=over 4
+
+=item B<CpuPoolStats> B<false>|B<true>
+
+When enabled, statistics about the processor pool are read, too. The partition
+needs to have pool authority in order to be able to acquire this information.
+Defaults to false.
+
+=item B<ReportBySerial> B<false>|B<true>
+
+If enabled, the serial of the physical machine the partition is currently
+running on is reported as I<hostname> and the logical hostname of the machine
+is reported in the I<plugin instance>. Otherwise, the logical hostname will be
+used (just like other plugins) and the I<plugin instance> will be empty.
+Defaults to false.
+
+=back
+
 =head2 Plugin C<mbmon>
 
 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.