]> git.ipfire.org Git - thirdparty/collectd.git/commitdiff
[collectd 6] src/collectd.conf.pod polish the WriteQueueLimitHigh/Low docs
authorLeonard Göhrs <leonard@goehrs.eu>
Fri, 28 Oct 2022 08:02:01 +0000 (10:02 +0200)
committerMatthias Runge <mrunge@matthias-runge.de>
Mon, 27 Feb 2023 17:37:53 +0000 (18:37 +0100)
The behaviour of LimitHight/LimitLow has changed with the switch to one
thread per write plugin. This warrants a rewrite of the respective
documentation. Thanks to @eero-t for the suggestion.

src/collectd.conf.pod

index 9e0c37b507181e6815da447ab3747d6672e3ea8d..14fbd04a535e2d614b93c43f4b3fec035c5f4cc5 100644 (file)
@@ -297,13 +297,15 @@ likely not an issue for clients, i.e. instances that only handle the local
 metrics. For servers it is recommended to set this to a non-zero value, though.
 
 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
-Each of them takes a numerical argument which is the number of metrics in the
-queue. If there are I<HighNum> metrics in the queue a random element from the
-queue will be dropped. This results in the data becoming more and more sparse
-without dropping a lot of continguous values. An exception from the random
-selection of elements to drop are the I<LowNum> most recent elements which will
-never be dropped. This can be used to ensure that one miss-behaving write
-plugin does not result in dropped values for other well-behaved write plugins.
+Each of them takes a numerical argument which correspond to the number of
+metrics in the queue.
+If there are B<HighNum> metrics in the queue a random element from the queue
+will be dropped. An exception from the random selection of elements to drop are
+the B<LowNum> most recent elements, which will never be dropped.
+Spreading the loss over the B<LowNum> - B<HighNum> range of least recent
+elements avoids large time gaps in the data on write hiccups.
+This way one miss-behaving write plugin is less likely to result in dropped
+values for well-behaved write plugins.
 
 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
 unset, the latter will default to half of B<WriteQueueLimitHigh>.