Code

collectd.conf(5): Improve documentation of the CollectdInternalStats option.
authorYves Mettier <ymettier@free.fr>
Tue, 15 Dec 2015 09:55:17 +0000 (09:55 +0000)
committerFlorian Forster <octo@collectd.org>
Thu, 17 Dec 2015 09:24:48 +0000 (10:24 +0100)
Signed-off-by: Florian Forster <octo@collectd.org>
src/collectd.conf.pod

index 8189e9734bc098225626157a3ebbab0e90ef16d3..7cf5c7505482bd9c7a5d4ecbae3730098f69bf85 100644 (file)
@@ -150,9 +150,21 @@ plugins that don't provide any configuration, e.g. the I<Load plugin>.
 When set to B<true>, various statistics about the I<collectd> daemon will be
 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
 
-The "write_queue" I<plugin instance> reports the number of elements currently
-queued and the number of elements dropped off the queue by the
-B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
+The "write_queue" I<plugin instance> reports :
+
+=over 4
+
+"queue_length" I<type> : the number of elements currently queued. You may want
+to limit this queue with the B<WriteQueueLimitLow>/B<WriteQueueLimitHigh>
+mechanism.
+
+"derive-dropped" I<type>-I<type instance> : the number of elements dropped. If
+this value is nul, either everything is going well or you set 
+B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> too high. If this value is not nul
+too often, either you set B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> too low
+or you have a serious problem.
+
+=back
 
 The "cache" I<plugin instance> reports the number of elements in the value list
 cache (the cache you can interact with using L<collectd-unixsock(5)>).