Merge branch 'master' into katzj/memory
authorFlorian Forster <octo@collectd.org>
Tue, 14 Jan 2014 07:43:06 +0000 (08:43 +0100)
committerFlorian Forster <octo@collectd.org>
Tue, 14 Jan 2014 07:43:06 +0000 (08:43 +0100)
1  2 
src/collectd.conf.in
src/collectd.conf.pod

diff --combined src/collectd.conf.in
  #     </Instance>
  #</Plugin>
  
 +#<Plugin memory>
 +#     ValuesAbsolute true
 +#     ValuesPercentage false
 +#</Plugin>
 +
  #<Plugin modbus>
  #     <Data "data_name">
  #             RegisterBase 1234
  #<Plugin "swap">
  #     ReportByDevice false
  #     ReportBytes true
+ #     ValuesAbsolute true
+ #     ValuesPercentage false
  #</Plugin>
  
  #<Plugin "table">
diff --combined src/collectd.conf.pod
@@@ -1603,17 -1603,17 +1603,17 @@@ transfer agents and web caches
  
  =item B<ValuesAbsolute> B<true>|B<false>
  
- Enables or disables reporting of free, used and used disk space in 1K-blocks. 
- Defaults to true.
+ Enables or disables reporting of free, used and used disk space in 1K-blocks.
+ Defaults to B<true>.
  
- =item B<ValuesPercentage> B<true>|B<false>
+ =item B<ValuesPercentage> B<false>|B<true>
  
  Enables or disables reporting of free, used and used disk space in percentage.
- Defaults to false.
+ Defaults to B<false>.
  
- This is useful for deploying collectd on the cloud, where machines with
- different disk size may exist. Then it is more practical to configure thresholds
- based on relative disk size.
+ This is useful for deploying I<collectd> on the cloud, where machines with
+ different disk size may exist. Then it is more practical to configure
thresholds based on relative disk size.
  
  =back
  
@@@ -2430,11 -2430,11 +2430,11 @@@ B<Synopsis:
     Temperature vddg
     Temperature vddq
     IgnoreSelectedTemperature true
+    
     ShowPower true
     Power total0
     Power total1
-    IgnoreSelectedPower true   
+    IgnoreSelectedPower true
   </Plugin>
  
  The following options are valid inside the B<PluginE<nbsp>mic> block:
@@@ -2491,7 -2491,7 +2491,7 @@@ Fan I
  
  =item fout
  
- Fan Out 
+ Fan Out
  
  =item vccp
  
@@@ -2532,11 -2532,11 +2532,11 @@@ Known power names are
  
  =item total0
  
- Total power utilization averaged over Time Window 0 (uWatts). 
+ Total power utilization averaged over Time Window 0 (uWatts).
  
  =item total1
  
- Total power utilization averaged over Time Window 0 (uWatts). 
+ Total power utilization averaged over Time Window 0 (uWatts).
  
  =item inst
  
@@@ -2544,57 -2544,36 +2544,57 @@@ Instantaneous power (uWatts)
  
  =item imax
  
- Max instantaneous power (uWatts). 
+ Max instantaneous power (uWatts).
  
  =item pcie
  
- PCI-E connector power (uWatts). 
+ PCI-E connector power (uWatts).
  
  =item c2x3
  
- 2x3 connector power (uWatts). 
+ 2x3 connector power (uWatts).
  
  =item c2x4
  
- 2x4 connector power (uWatts). 
+ 2x4 connector power (uWatts).
  
  =item vccp
  
- Core rail (uVolts). 
+ Core rail (uVolts).
  
  =item vddg
  
- Uncore rail (uVolts). 
+ Uncore rail (uVolts).
  
  =item vddq
  
- Memory subsystem rail (uVolts). 
+ Memory subsystem rail (uVolts).
  
  =back
  
  =back
  
 +=head2 Plugin C<memory>
 +
 +The I<memory plugin> provides the following configuration options:
 +
 +=over 4
 +
 +=item B<ValuesAbsolute> B<true>|B<false>
 +
 +Enables or disables reporting of physical memory usage in absolute numbers,
 +i.e. bytes. Defaults to B<true>.
 +
 +=item B<ValuesPercentage> B<false>|B<true>
 +
 +Enables or disables reporting of physical memory usage in percentages, e.g.
 +percent of physical memory used. Defaults to B<true>.
 +
 +This is useful for deploying I<collectd> in a heterogeneous environment in
 +which the sizes of physical memory vary.
 +
 +=back
 +
  =head2 Plugin C<modbus>
  
  The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
@@@ -5377,6 -5356,19 +5377,19 @@@ This option is only available if the I<
  When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
  I<swap I/O> is reported in pages. This option is available under Linux only.
  
+ =item B<ValuesAbsolute> B<true>|B<false>
+ Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
+ available and used. Defaults to B<true>.
+ =item B<ValuesPercentage> B<false>|B<true>
+ Enables or disables reporting of relative swap metrics, i.e. I<percent>
+ available and free. Defaults to B<false>.
+ This is useful for deploying I<collectd> in a heterogeneous environment, where
+ swap sizes differ and you want to specify generic thresholds or similar.
  =back
  
  =head2 Plugin C<syslog>