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

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

index b0ed0ed..016edf5 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -775,6 +775,18 @@ 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<SSLCiphers> I<list of ciphers>
+
+Specifies which ciphers to use in the connection. The list of ciphers
+must specify valid ciphers. See
+L<http://www.openssl.org/docs/apps/ciphers.html> for details.
+
+=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 +875,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 +1178,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 +1512,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 +1530,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 +1628,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 +1730,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 +4159,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>
@@ -7171,6 +7221,26 @@ are available on the server side. I<Bytes> must be at least 1024 and cannot
  exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
  Defaults to C<4096>.
  
+=item B<LowSpeedLimit> I<Bytes per Second>
+
+Sets the minimal transfer rate in I<Bytes per Second> below which the
+connection with the HTTP server will be considered too slow and aborted. All
+the data submitted over this connection will probably be lost. Defaults to 0,
+which means no minimum transfer rate is enforced.
+
+=item B<Timeout> I<Timeout>
+
+Sets the maximum time in milliseconds given for HTTP POST operations to
+complete. When this limit is reached, the POST operation will be aborted, and
+all the data in the current send buffer will probably be lost. Defaults to 0,
+which means the connection never times out.
+
+The C<write_http> plugin regularly submits the collected values to the HTTP
+server. How frequently this happens depends on how much data you are collecting
+and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
+slightly below this interval, which you can estimate by monitoring the network
+traffic between collectd and the HTTP server.
+
  =back
  
  =head2 Plugin C<write_kafka>