From: Marc Fournier <marc.fournier@camptocamp.com>
Date: Thu, 25 Sep 2014 16:54:56 +0000 (+0200)
Subject: statsd: clarify/simplify documentation & example
X-Git-Tag: collectd-5.4.2~11
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=b594d048c7a8856be5984d5cc42b3a5d66863333;p=collectd.git

statsd: clarify/simplify documentation & example
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index ec2d51ca..3a8609a1 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -967,6 +967,8 @@
 #  DeleteGauges   false
 #  DeleteSets     false
 #  TimerPercentile 90.0
+#  TimerPercentile 95.0
+#  TimerPercentile 99.0
 #  TimerLower     false
 #  TimerUpper     false
 #  TimerSum       false
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 987ac88b..8a6614b2 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -5332,31 +5332,20 @@ that I<Percent> of all reported timers are smaller than or equal to the
 computed latency. This is useful for cutting off the long tail latency, as it's
 often done in I<Service Level Agreements> (SLAs).
 
-If not specified, no percentile is calculated / dispatched.
+Different percentiles can be calculated by setting this option several times.
+If none are specified, no percentiles are calculated / dispatched.
 
 =item B<TimerLower> B<false>|B<true>
 
-Calculates and dispatch the lowest value for the metric in an inteval.
-
-If set to B<False>, no lowest value is calculated / dispatched.
-
 =item B<TimerUpper> B<false>|B<true>
 
-Calculates and dispatch the highest value for the metric in an inteval.
-
-If set to B<False>, no highest value is calculated / dispatched.
-
 =item B<TimerSum> B<false>|B<true>
 
-Calculates and dispatch a sum for all the values for the metric in an inteval.
-
-If set to B<False>, no sum value is calculated / dispatched.
-
 =item B<TimerCount> B<false>|B<true>
 
-Calculates and dispatch a count of all the values for the metric been sent in an inteval.
-
-If set to B<False>, no count value is calculated / dispatched.
+Calculate and dispatch various values out of I<Timer> metrics received during
+an interval. If set to B<False>, the default, these values aren't calculated /
+dispatched.
 
 =back