swap plugin: Add the "ReportBytes" option.

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 75f79429630e7c7b49c23ec4765a9412b1f9cbd4..f359e9a08cca8e5806490b4a44a252f3d8b52431 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -4031,6 +4031,23 @@ Since the configuration of the C<snmp plugin> is a little more complicated than
 other plugins, its documentation has been moved to an own manpage,
 L<collectd-snmp(5)>. Please see there for details.
 
+=head2 Plugin C<swap>
+
+The C<swap plugin> reports the number of bytes currently swapped out and the
+amount of swap space available. The precise metrics being exported depends on
+your operating system.
+
+Options:
+
+=over 4
+
+=item B<ReportBytes> B<false>|B<true>
+
+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.
+
+=back
+
 =head2 Plugin C<syslog>
 
 =over 4