Merge remote-tracking branch 'origin/pr/993'

[collectd.git] / src / collectd.conf.pod
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod

index 524c435..8ce4a86 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -775,6 +775,12 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will
  possibly need this option. What CA certificates come bundled with C<libcurl>
  and are checked by default depends on the distribution you use.
  
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout.
+
  =back
  
  =head2 Plugin C<apcups>
@@ -863,6 +869,12 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will
  possibly need this option. What CA certificates come bundled with C<libcurl>
  and are checked by default depends on the distribution you use.
  
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout.
+
  =back
  
  =head2 Plugin C<barometer>
@@ -1160,6 +1172,12 @@ Collect global memory statistics.
  
  Default: Enabled.
  
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout.
+
  =item B<View> I<Name>
  
  Collect statistics about a specific I<"view">. BIND can behave different,
@@ -1488,6 +1506,10 @@ C<application/x-www-form-urlencoded>).
  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>
@@ -1502,6 +1524,18 @@ plugin below on how matches are defined. If the B<MeasureResponseTime> or
  B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
  optional.
  
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, 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.
+
+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
  
  =head2 Plugin C<curl_json>
@@ -1588,6 +1622,8 @@ URL. By default the global B<Interval> setting will be used.
  
  =item B<Post> I<Body>
  
+=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.
  
@@ -1688,6 +1724,8 @@ Examples:
  
  =item B<Post> I<Body>
  
+=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.
  
@@ -4115,6 +4153,12 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will
  possibly need this option. What CA certificates come bundled with C<libcurl>
  and are checked by default depends on the distribution you use.
  
+=item B<Timeout> I<Milliseconds>
+
+The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout.
+
  =back
  
  =head2 Plugin C<notify_desktop>