From: Florian Forster <octo@collectd.org>
Date: Wed, 12 Oct 2016 15:15:10 +0000 (+0200)
Subject: collectd.conf(5): Update the "LatencyRate" option.
X-Git-Tag: collectd-5.7.0~18
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=91ede7c26b9a46345861b40e9bb387f945b6694c;p=collectd.git

collectd.conf(5): Update the "LatencyRate" option.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 037371bc..1a696693 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -1287,9 +1287,9 @@
 #      LatencyPercentile 70
 #      LatencyPercentile 95
 #      LatencyRateType "requests"
-#      LatencyRate 0.001 0.100
-#      LatencyRate 0.101 0.200
-#      LatencyRate 0.201 0
+#      LatencyRate 0     0.100
+#      LatencyRate 0.100 0.200
+#      LatencyRate 0.200 0
 #    </Match>
 #  </File>
 #</Plugin>
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 74fb977e..1abca916 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -7222,20 +7222,23 @@ computed latency.
 Different percentiles can be calculated by setting this option several times.
 
 =item B<LatencyPercentileType> I<Type>
+
 Sets the type used to dispatch B<LatencyPercentile> values.
 
 =item B<LatencyRate> I<lower_latency> I<upper_latency>
 
 Calculate and dispatch rate of latency values fall within requested interval.
-Interval is specified as [I<lower_latency>, I<upper_latency>] (including
-boundaries). Rate cannot be reported for 0.000 latency, so I<lower_latency>
-should be 0.001 or greater. When I<upper_latency> value is equal to 0 then
-interval is [lower, infinity).
+Both, I<lower_latency> and I<upper_latency> is a duration in seconds and can be
+a fractional number, such as B<0.5>. The settings specify the interval
+C<(I<lower_latency>, I<upper_latency>]>, i.e. the range I<excludes> the lower
+bound and I<includes> the upper bound. I<lower_latency> and I<upper_latency>
+can be zero, meaning no lower/upper bound.
 
 Rates for different intervals can be calculated by setting this option several
 times.
 
 =item B<LatencyRateType> I<Type>
+
 Sets the type used to dispatch B<LatencyRate> values.
 
 =back