updated Readme: added option ratio-random-hosts, mentioned range format in ping-inter...

diff --git a/Readme b/Readme
index 2f06f23..ba2b941 100644 (file)
--- a/Readme
+++ b/Readme
@@ -64,9 +64,8 @@ block.
 ---------------------------------------
 This configurations are shared among and affect all the hosts.
 - default-source-network-interface: the local network interface from where the
-  ping packages will originate. If this configuration is present, all hosts
-  will use this interface as source, otherwise, a per host source-network-
-  interface must be provided.
+  ping packages will originate. This option is used for those hosts that set
+  source-network-interface=default
 - nameserver: the server which the hosts names will be resolved. It is the
   lookup server which the application will query first. If left blank or omited,
   it will use the /etc/resolv.conf.
@@ -84,19 +83,24 @@ This configurations are shared among and affect all the hosts.
   success in order to consider the link up, or stable.
 - link-down-interval: how long (in minutes) the pings must fail, in order to the
   application consider the link down.
+- ratio-random-hosts: expects a value in [0,1]; if <1 will only use the given
+  ratio of hosts, selecting them at random
 
 
 2.2. Host
 ---------------------------------------
+(All these settings must always be present!)
 - name: the DNS or IP of the host to ping. Take in consideration that, if a
   DNS is given, the application pings all IPs in the look up table, however, if
   IP is provide, it is the only which will be pinged.
 - port: when using a port based protocol, like TCP, this field specifies in
   which port to ping the host.
 - source-network-interface: the local network interface from where the ping
-  packages for a given host will originate. This setting is used only if the
-  global network interface was not provided.
-- interval: the host will be pinged every "interval" seconds.
+  packages for a given host will originate. To use the global network
+  interface, specify value as "default"
+- interval: the host will be pinged every "interval" seconds. Can be specified
+  as fixed number (e.g. "30") or as a range (e.g. "30..60"), from which the
+  interval will be picked at random (e.g. 42) at startup
 - ping-protocol: indicates which protocol to use to ping the destination host,
   the currently supported protocols are TCP (tcp, tcp_ipv6) and ICMP (icmp, icmpv6).