From: Yves Mettier <ymettier@free.fr>
Date: Tue, 15 Dec 2015 09:55:17 +0000 (+0000)
Subject: collectd.conf(5): Improve documentation of the CollectdInternalStats option.
X-Git-Tag: collectd-5.5.1~17
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=b0743c5554fafc6c96180949a8da3766e481b4bd

collectd.conf(5): Improve documentation of the CollectdInternalStats option.

Signed-off-by: Florian Forster <octo@collectd.org>
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 8189e973..7cf5c750 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -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)>).