svc/connect.in: Report statistics about adopted peers.

[tripe] / svc / connect.8.in

diff --git a/svc/connect.8.in b/svc/connect.8.in
index 7112fb0c43b3468f4a9dc28361533aabde2e4555..0d951bf7ba1aad69255cbabe7f997813c389a440 100644 (file)
--- a/svc/connect.8.in
+++ b/svc/connect.8.in
@@ -523,7 +523,7 @@ provided about each peer, in the form of subsequent tokens.  Clients
 should be prepared to ignore such tokens.)
 .SP
 .BI "info " peer
-Lists the database record for the named
+Lists the database record and additional information about the named
 .IR peer .
 For each key/value pair, a line
 .RS
@@ -532,6 +532,67 @@ For each key/value pair, a line
 .IB key = value
 .PP
 is output.  The key/value pairs are output in an arbitrary order.
+.PP
+In addition to the fields of the peer's database record, the following
+additional keys are defined.
+.TP
+.B failures
+The number of failed pings in the current or most recent batch, in
+decimal.
+.TP
+.B last-ping
+The round-trip time of the most recent ping in milliseconds, in the form
+.IB nn.n ms\fR,
+or
+.B timeout
+if the most recent ping timed out,
+or
+.B \-
+if no pings have yet completed.
+.TP
+.B max-ping
+The maximum successful ping time so far in milliseconds, in the form
+.IB nn.n ms\fR,
+or
+.B \-
+if no pings have yet succeeded.
+.TP
+.B mean-ping
+The average successful ping time so far in milliseconds, in the form
+.IB nn.n ms\fR,
+or
+.B \-
+if no pings have yet succeeded.
+.TP
+.B min-ping
+The minimum successful ping time so far in milliseconds, in the form
+.IB nn.n ms\fR,
+or
+.B \-
+if no pings have yet succeeded.
+.TP
+.B n-lost
+The number of pings which have been declared timed out so far, in
+decimal.
+.TP
+.B n-ping
+The number of successful pings so far, in decimal.
+.TP
+.B sd-ping
+The standard deviation of ping times so far in milliseconds, in the form
+.IB nn.n ms\fR,
+or
+.B \-
+if no pings have yet succeeded.
+.TP
+.B state
+One of the strings:
+.B idle
+if the peer has responded to a ping recently, and we are waiting for the
+.B every
+delay before we try again; or
+.B check
+if we are currently waiting for a ping to return.
 .RE
 .SP
 .BI "kick " peer