From 9d3fb4e714753fa281360ddbd59493430f1e92a9 Mon Sep 17 00:00:00 2001
From: Evan Felix <e@pnnl.gov>
Date: Tue, 14 May 2013 15:13:04 -0700
Subject: [PATCH] Add Documentaion for Power collection in the mic plugin

---
 src/collectd.conf.in  | 10 ++++--
 src/collectd.conf.pod | 84 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 92 insertions(+), 2 deletions(-)

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index e103863a..2010d338 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -1032,11 +1032,17 @@
 #   ShowCPUCores true
 #   ShowMemory true
 #   ShowTemperatures true
-##  Temperature Sensors can be ignored/shown by repeaded #TempSensor lines, and
-##  then inverted with a IgnoreTempSelected.
+##  Temperature Sensors can be ignored/shown by repeated #Temperature lines, and
+##  then inverted with a IgnoreSelectedTemperature.
 ##  Known Temperature sensors: die, devmem, fin, fout, vccp, vddg, vddq
 #   Temperature vddg
 #   IgnoreSelectedTemperature true
+#   ShowPower true
+##  Power Sensors can be ignored/shown by repeated #Power lines, and
+##  then inverted with a IgnoreSelectedTemperature.
+##  Known Temperature sensors: total0, total1, inst, imax, pci3, c2x3, c2x4, vccp, vddg, vddq
+#   Power total1
+#   IgnoreSelectedPower true
 #</Plugin>
 
 #<Plugin varnish>
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 242c8f84..ca11bdb2 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2255,6 +2255,11 @@ B<Synopsis:>
    Temperature vddg
    Temperature vddq
    IgnoreSelectedTemperature true
+
+   ShowPower true
+   Power total0
+   Power total1
+   IgnoreSelectedPower true   
  </Plugin>
 
 The following options are valid inside the B<PluginE<nbsp>mic> block:
@@ -2299,18 +2304,97 @@ Known temperature names are:
 
 =item die
 
+Die. hello
+
 =item devmem
 
+Device Memory
+
 =item fin
 
+Fan In
+
 =item fout
 
+Fan Out 
+
+=item vccp
+
+Voltage ccp
+
+=item vddg
+
+Voltage ddg
+
+=item vddq
+
+Voltage ddq
+
+=back
+
+=item B<ShowPower> B<true>|B<false>
+
+If enabled (the default) various temperatures of the MIC system are reported.
+
+=item B<Power> I<Name>
+
+This option controls which power readings are being reported. Whether matching
+power readings are being ignored or I<only> matching power readings are reported
+depends on the B<IgnoreSelectedPower> setting below. By default I<all>
+power readings are reported.
+
+=item B<IgnoreSelectedPower> B<false>|B<true>
+
+Controls the behavior of the B<Power> setting above. If set to B<false>
+(the default) only power readings matching a B<Power> option are reported
+or, if no B<Power> option is specified, all power readings are reported. If
+set to B<true>, matching power readings are I<ignored> and all other power readings
+are reported.
+
+Known power names are:
+
+=over 4
+
+=item total0
+
+Total power utilization averaged over Time Window 0 (uWatts). 
+
+=item total1
+
+Total power utilization averaged over Time Window 0 (uWatts). 
+
+=item inst
+
+Instantaneous power (uWatts).
+
+=item imax
+
+Max instantaneous power (uWatts). 
+
+=item pcie
+
+PCI-E connector power (uWatts). 
+
+=item c2x3
+
+2x3 connector power (uWatts). 
+
+=item c2x4
+
+2x4 connector power (uWatts). 
+
 =item vccp
 
+Core rail (uVolts). 
+
 =item vddg
 
+Uncore rail (uVolts). 
+
 =item vddq
 
+Memory subsystem rail (uVolts). 
+
 =back
 
 =back
-- 
2.30.2