From: Florian Forster <octo@collectd.org>
Date: Sun, 12 Jan 2014 11:26:36 +0000 (+0100)
Subject: collectd.conf(5): Document the memory plugin's Values{Absolute,Percentage} options.
X-Git-Tag: collectd-5.5.0~288^2~12
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=ec48743ad9a09498fe4c8156ae5b67529cfdb435;p=collectd.git

collectd.conf(5): Document the memory plugin's Values{Absolute,Percentage} options.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 4de39f0a..47107af1 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -539,6 +539,11 @@
 #	</Instance>
 #</Plugin>
 
+#<Plugin memory>
+#	ValuesAbsolute true
+#	ValuesPercentage false
+#</Plugin>
+
 #<Plugin modbus>
 #	<Data "data_name">
 #		RegisterBase 1234
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 3a79b0fd..1c9c00b6 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -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