collectd.conf(5): Document the memory plugin's Values{Absolute,Percentage} options.
authorFlorian Forster <octo@collectd.org>
Sun, 12 Jan 2014 11:26:36 +0000 (12:26 +0100)
committerFlorian Forster <octo@collectd.org>
Sun, 12 Jan 2014 11:26:36 +0000 (12:26 +0100)
src/collectd.conf.in
src/collectd.conf.pod

index 4de39f0..47107af 100644 (file)
 #      </Instance>
 #</Plugin>
 
+#<Plugin memory>
+#      ValuesAbsolute true
+#      ValuesPercentage false
+#</Plugin>
+
 #<Plugin modbus>
 #      <Data "data_name">
 #              RegisterBase 1234
index 3a79b0f..1c9c00b 100644 (file)
@@ -2574,6 +2574,27 @@ Memory subsystem rail (uVolts).
 
 =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