Repository : ssh://git@open-mesh.org/doc
On branches: backup-redmine/2017-07-13,master
commit f6684821b2a9fa118fbb7657ec7c3af2e6494a11 Author: Marek Lindner mareklindner@neomailbox.ch Date: Mon Jun 21 00:06:24 2010 +0000
doc: batmand/VisOutput
f6684821b2a9fa118fbb7657ec7c3af2e6494a11 batmand/VisOutput.textile | 43 ++++++++++++++++--------------------------- 1 file changed, 16 insertions(+), 27 deletions(-)
diff --git a/batmand/VisOutput.textile b/batmand/VisOutput.textile index e41f1502..d466fe53 100644 --- a/batmand/VisOutput.textile +++ b/batmand/VisOutput.textile @@ -1,14 +1,13 @@
-== Working with the vis server output == += Working with the vis server output =
-This artcile is for those that intend to write their own visualization tool, combine the vis [[BR]] -output with a map or want to understand the vis server output for another reason. [[BR]] -''If you want to setup the vis server for the batmand have a look at this [wiki:VisualizeMesh article] or for [[BR]] -BATMAN-Advanced at [wiki:VisAdv this one]. [[BR]] +{{{ +#!div style="width: 46em; text-align: justify" + +This artcile is for those that intend to write their own visualization tool, combine the vis output with a map or want to understand the vis server output for another reason. If you want to setup the vis server for the batmand have a look at this [wiki:VisualizeMesh article] or for BATMAN-Advanced at [wiki:VisAdv this one].
-Here is a sample output from the vis server in the dot draw format. Newer vis versions offer [[BR]] -alternative formats (e.g. JSON) which follow the same rules but use another output style. [[BR]] +Here is a sample output from the vis server in the dot draw format. Newer vis versions offer alternative formats (e.g. JSON) which follow the same rules but use another output style.
{{{ digraph topology @@ -22,10 +21,7 @@ digraph topology } }}}
-Each "digraph { ... }" block contains a complete dump of the vis servers internal database [[BR]] -at a given time. Every line contains the IP address of a batman node, a network it has a [[BR]] -relation to and a label. All nodes sending information to the vis server are listed in the first [[BR]] -column. If a node is missing you should check whether there is a connection problem. [[BR]] +Each "digraph { ... }" block contains a complete dump of the vis servers internal database at a given time. Every line contains the IP address of a batman node, a network it has a relation to and a label. All nodes sending information to the vis server are listed in the first column. If a node is missing you should check whether there is a connection problem.
[[BR]]
@@ -36,20 +32,11 @@ column. If a node is missing you should check whether there is a connection prob "5.224.160.202" -> "5.174.37.225"[label="1.28"] }}}
-The batman node 5.174.37.225 has a connection towards the batman node 5.224.160.202 [[BR]] -with a link quality of "2.13" whereas the 5.224.160.202 has a link quality of "1.28" towards [[BR]] -the 5.174.37.225. The connection is listed twice because each node reports it individually [[BR]] -which gives you the option of seeing asymetric links if you want to display it. [[BR]] +The batman node 5.174.37.225 has a connection towards the batman node 5.224.160.202 with a link quality of "2.13" whereas the 5.224.160.202 has a link quality of "1.28" towards the 5.174.37.225. The connection is listed twice because each node reports it individually which gives you the option of seeing asymetric links if you want to display it.
-The link quality gives information how batman evaluates this link. 1.00 means 100%25 link [[BR]] -quality, 2.00 means 50%25, 3.00 is 33.3%25 and 4.00 is 25%25, etc. The number tells you how [[BR]] -many packets you need to send in order to get a single successful transmission. [[BR]] +The link quality gives information how batman evaluates this link. 1.00 means 100%25 link quality, 2.00 means 50%25, 3.00 is 33.3%25 and 4.00 is 25%25, etc. The number tells you how many packets you need to send in order to get a single successful transmission.
-While looking at originator tables, debug logs or other batman output you might see different [[BR]] -numbers. Due to performance considerations batman uses his own format (TQ value) to [[BR]] -express link quality. Its max value is 255 and goes down to 0 (float operations are quite [[BR]] -expensive on embedded devices). The vis server transforms the TQ value into its own format [[BR]] -before outputting it. [[BR]] +While looking at originator tables, debug logs or other batman output you might see different numbers. Due to performance considerations batman uses his own format (TQ value) to express link quality. Its max value is 255 and goes down to 0 (float operations are quite expensive on embedded devices). The vis server transforms the TQ value into its own format before outputting it.
[[BR]]
@@ -59,8 +46,7 @@ before outputting it. [[BR]] "5.224.160.202" -> "0.0.0.0/0.0.0.0"[label="HNA"] }}}
-The 5.224.160.202 announces a connection to the internet: "0.0.0.0/0.0.0.0" and the HNA label [[BR]] -represent gateway functionality in the output. +The 5.224.160.202 announces a connection to the internet: "0.0.0.0/0.0.0.0" and the HNA label represent gateway functionality in the output.
[[BR]]
@@ -70,16 +56,19 @@ represent gateway functionality in the output. "5.174.37.225" -> "192.168.15.0/24"[label="HNA"] }}}
-The 5.174.37.225 announces a connection to the 192.168.15.0/24 network (which does not run [[BR]] -batman). All nodes that establish a connection to this network use the 5.174.37.225 as gateway. +The 5.174.37.225 announces a connection to the 192.168.15.0/24 network (which does not run batman). All nodes that establish a connection to this network use the 5.174.37.225 as gateway.
=== Interfaces belonging to one BATMAN-Adv node ===
In BATMAN-Advanced since revision 1424, the subgraphing/cluster feature of the dot-file-format has been added to mark interfaces as belonging to the same originator. Every originator the vis-server found has such an additional subgraph block: + {{{ subgraph "cluster_00:11:22:33:44:55" { "00:11:22:33:44:55" [peripheries=2] "01:23:45:67:89:AB" } }}} + In this example the originator '00:11:22:33:44:55' has two active interfaces, "00:11:22:33:44:55" and "01:23:45:67:89:AB". With 'fdp' from the [http://www.graphviz.org/ graphviz-tools] for instance such interfaces inside of a subgraph would be surrounded by a box. The cluster-prefix is a prerequisite for this tool here to describe the relation between those interfaces and is not a label being visualized. Additionally, the ''primary'' interface gets the extra attribute '[peripheries=2]' which is the only interface known to other BATMAN-Nodes, except to direct neighbours (with graphviz, such an interface gets double circled). + +}}} \ No newline at end of file