![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: bce14a8)
raw | patch | inline | side by side (parent: bce14a8)
| author | Marc Fournier <marc.fournier@camptocamp.com> | |
| Thu, 2 Apr 2015 16:29:05 +0000 (18:29 +0200) | ||
| committer | Marc Fournier <marc.fournier@camptocamp.com> | |
| Sat, 4 Apr 2015 20:15:13 +0000 (22:15 +0200) |
Also clarify the ins and outs of stalled network connections regarding
threads consumption and add warning about timeouts and
MeasureResponseTime.
threads consumption and add warning about timeouts and
MeasureResponseTime.
| src/collectd.conf.pod | patch | blob | history |
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 6b76c9112e4428d1758b314897476ec30491da34..9dd162e21580eb956cc224b8654a89f06f6f2ab7 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
Measure response time for the request. If this setting is enabled, B<Match>
blocks (see below) are optional. Disabled by default.
+Beware that requests will get aborted if they take too long to complete. Adjust
+B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
+requests.
+
=item B<MeasureResponseCode> B<true>|B<false>
Measure response code for the request. If this setting is enabled, B<Match>
B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
optional.
-=item B<Timeout> I<Timeout in miliseconds>
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout. Prior to version 5.5.0, there was no timeout and requests could hang
+indefinitely. This legacy behaviour can be achieved by setting the value of
+B<Timeout> to 0.
-The B<Timeout> option sets the overall timeout for each request. Make sure that
-collectd is configured with enough C<ReadThreads>, otherwise an overly long
-timeout could block other plugins. By default or when set to B<0>, a timeout
-equal to the B<Interval> is used. Prior to version 5.5.0, there was no timeout
-and requests might hang indefinitely.
+If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
+network connection will stall one read thread. Adjust the B<ReadThreads> global
+setting accordingly to prevent this from blocking other plugins.
=back
=item B<Header> I<Header>
=item B<Post> I<Body>
-=item B<Timeout> I<Timeout in miliseconds>
+
+=item B<Timeout> I<Milliseconds>
These options behave exactly equivalent to the appropriate options of the
I<cURL> plugin. Please see there for a detailed description.