apache: Add support for specifying a connection timeout

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

index 905689d..07ef54f 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -519,6 +519,7 @@ possibly filtering or messages.
   #   ExchangeType "fanout"
   #   RoutingKey "collectd"
   #   Persistent false
+ #   ConnectionRetryDelay 0
   #   Format "command"
   #   StoreRates false
   #   GraphitePrefix "collectd."
@@ -540,6 +541,7 @@ possibly filtering or messages.
   #   QueueDurable false
   #   QueueAutoDelete true
   #   RoutingKey "collectd.#"
+ #   ConnectionRetryDelay 0
     </Subscribe>
   </Plugin>
  
@@ -630,6 +632,13 @@ mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
  default), the I<transient> delivery mode will be used, i.e. messages may be
  lost due to high load, overflowing queues or similar issues.
  
+=item B<ConnectionRetryDelay> I<Delay>
+
+When the connection to the AMQP broker is lost, defines the time in seconds to
+wait before attempting to reconnect. Defaults to 0, which implies collectd will
+attempt to reconnect at each read interval (in Subscribe mode) or each time
+values are ready for submission (in Publish mode).
+
  =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
  
  Selects the format in which messages are sent to the broker. If set to
@@ -766,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, in
+milliseconds. By default, the configured B<Interval> is used to set the
+timeout.
+
  =back
  
  =head2 Plugin C<apcups>
@@ -1446,6 +1461,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>
@@ -1460,6 +1479,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, 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>
@@ -1546,6 +1577,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.
  
@@ -1646,6 +1679,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.