updates from CR
Jeromy committed
Jan 27, 2015 at 17:28 UTC
b456d476a3c68c34c259202d733182156e885e97
1 file changed
+12
-7
core/commands/diag.go
+12
-7
@@ -57,25 +57,30 @@ Sends out a message to each node in the network recursively
57
requesting a listing of data about them including number of
58
connected peers and latencies between them.
59
60
-The given timeout will be stepped down for each peer the
61
-request is sent to, to ensure that all peers return in an
62
-order that will result in the most responses to the initiator.
60
+The given timeout will be decremented 2s at every network hop,
61
+ensuring peers try to return their diagnostics before the initiator's
62
+timeout. If the timeout is too small, some peers may not be reached.
63
+30s and 60s are reasonable timeout values, though network vary.
64
The default timeout is 20 seconds.
65
66
The 'vis' option may be used to change the output format.
66
-Currently, two alternate formats are supported, d3, and json.
67
+four formats are supported:
68
+ * plain text - easy to read
69
+ * d3 - json ready to be fed into d3view
70
+ * dot - graphviz format
71
+
72
The d3 format will output a json object ready to be consumed by
73
the chord network viewer, available at the following hash:
74
70
- QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38
75
+ /ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38
76
77
To view your diag output, 'ipfs add' the d3 vis output, and
78
open the following link:
79
80
http://gateway.ipfs.io/ipfs/QmbesKpGyQGd5jtJFUGEB1ByPjNFpukhnKZDnkfxUiKn38/chord#<your hash>
81
77
-The json option for vis output can also be used for other
78
-programs that want to consume diagnostic output.
82
+The dot format can be fed into graphviz and other programs
83
+that consume the dot format to generate graphs of the network.
84
`,
85
},
86