Merge remote-tracking branch 'github/pr/2059'

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index fce5903..dc8b1a3 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -4878,7 +4878,7 @@ so the values will not loop.
 =item B<ReportStats> B<true>|B<false>
 
 The network plugin cannot only receive and send statistics, it can also create
-statistics about itself. Collected data included the number of received and
+statistics about itself. Collectd data included the number of received and
 sent octets and packets, the length of the receive queue and the number of
 values handled. When set to B<true>, the I<Network plugin> will make these
 statistics available. Defaults to B<false>.
@@ -7973,6 +7973,12 @@ You can also specify combinations of the B<name> and B<uuid> fields.
 For example B<name uuid> means to concatenate the guest name and UUID
 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
 
+=item B<Instances> B<integer>
+
+How many read instances you want to use for this plugin. The default is one,
+and the sensible setting is a multiple of the B<ReadThreads> value.
+If you are not sure, just use the default setting.
+
 =back
 
 =head2 Plugin C<vmem>
@@ -8143,8 +8149,8 @@ packets.
 Synopsis:
 
  <Plugin write_tsdb>
-   DNS_Cache_TTL 60
-   DNS_Random_Cache_TTL 60
+   ResolveInterval 60
+   ResolveJitter 60
    <Node "example">
      Host "tsd-1.my.domain"
      Port "4242"
@@ -8159,24 +8165,26 @@ Global directives are:
 
 =over 4
 
-=item B<DNS_Cache_TTL> I<ttl>
+=item B<ResolveInterval> I<seconds>
 
-=item B<DNS_Random_Cache_TTL> I<ttl>
+=item B<ResolveJitter> I<seconds>
 
-When Collectd connects to a TSDB node, it will request the DNS. This can become
-a problem is the TSDN node is unavailable or badly configured because Collected
-will request DNS in order to reconnect for every metric, which can flood your DNS.
-So you can cache the last value for C<ttl> seconds (default: 600s e.g; 10 min).
+When I<collectd> connects to a TSDB node, it will request the hostname from
+DNS. This can become a problem if the TSDB node is unavailable or badly
+configured because collectd will request DNS in order to reconnect for every
+metric, which can flood your DNS. So you can cache the last value for
+I<ResolveInterval> seconds.
+Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
 
-You can also define a random ttl. This prevents all your Collectd servers to
-request the DNS at the same time when the connection fails. Default value is
-15 * the write_tsdb interval (or the global interval if write_tsdb interval is not
-defined).
+You can also define a jitter, a random interval to wait in addition to
+I<ResolveInterval>. This prevents all your collectd servers to resolve the
+hostname at the same time when the connection fails.
+Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
 
-Note : if the DNS resolution has already been successful, if the socket closes,
-the plugin will try to reconnect as soon as possible with the cached information.
-DNS is queried only when the socket is closed for a long time (DNS_Cache_TTL + 
-DNS_Random_Cache_TTL)
+B<Note:> If the DNS resolution has already been successful when the socket
+closes, the plugin will try to reconnect immediately with the cached
+information. DNS is queried only when the socket is closed for a longer than
+I<ResolveInterval> + I<ResolveJitter> seconds.
 
 =back