collectd.conf(5): Document the "Collect{IndividualUsers,UserCount}" options of the...
authorFlorian Forster <octo@leeloo.lan.home.verplant.org>
Mon, 22 Mar 2010 18:26:30 +0000 (19:26 +0100)
committerFlorian Forster <octo@leeloo.lan.home.verplant.org>
Mon, 22 Mar 2010 18:26:30 +0000 (19:26 +0100)
src/collectd.conf.pod

index 26cad5f..b1544e8 100644 (file)
@@ -2776,12 +2776,24 @@ Available options:
 
 Specifies the location of the status file.
 
-=item B<Compression> B<true>|B<false>
+=item B<CollectCompression> B<true>|B<false>
 
 Sets whether or not statistics about the compression used by OpenVPN should be
 collected. This information is only available in I<single> mode. Enabled by
 default.
 
+=item B<CollectIndividualUsers> B<true>|B<false>
+
+Sets whether or not traffic information is collected for each connected client
+individually. If set to false, currently no traffic data is collected at all
+because aggregating this data in a save manner is tricky. Defaults to B<true>.
+
+=item B<CollectUserCount> B<true>|B<false>
+
+When enabled, the number of currently connected clients or users is collected.
+This is expecially interesting when B<CollectIndividualUsers> is disabled, but
+can be configured independently from that option. Defaults to B<false>.
+
 =back
 
 =head2 Plugin C<oracle>