summaryrefslogtreecommitdiffstats
path: root/retiolum/scripts/adv_graphgen/README.md
diff options
context:
space:
mode:
authormakefu <root@pigstarter.de>2015-09-09 14:41:38 +0200
committermakefu <root@pigstarter.de>2015-09-09 14:41:38 +0200
commit05bf2c8be209e619f8c9e727fd1353198b042642 (patch)
tree4f7a9439137fe78f979b235666a3533f9e249eca /retiolum/scripts/adv_graphgen/README.md
parente9e7d6baf986488c43d418887f6cf95f5d896189 (diff)
begin packaging of tinc_stats
Diffstat (limited to 'retiolum/scripts/adv_graphgen/README.md')
-rw-r--r--retiolum/scripts/adv_graphgen/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/retiolum/scripts/adv_graphgen/README.md b/retiolum/scripts/adv_graphgen/README.md
new file mode 100644
index 00000000..082e0f2b
--- /dev/null
+++ b/retiolum/scripts/adv_graphgen/README.md
@@ -0,0 +1,28 @@
+The folder contains a number of scripts which provide a convenient way to
+generate advanced graphs from the SIGUSR2 output of tinc.
+
+it currently contains the following files:
+
+sanitize.sh:
+ wrapper arond parse.py which filters the syslog file for all tinc
+ related lines and removes the status informations:
+ this means that
+ <code>
+ May 19 20:40:44 servarch dnsmasq[5382]: reading /etc/resolv.conf
+ May 19 20:41:38 servarch tinc.retiolum[4780]: Error looking up pa-sharepoint.informatik.ba-stuttgart.de port 655: Name or service not known
+ </code>
+ becomes
+ <code>
+ Error looking up pa-sharepoint.informatik.ba-stuttgart.de port 655: Name or service not known
+ </code>
+ and so on.
+ It also provides a wrapper around graphviz which automagically
+ generates graphs from the produced graph file
+
+parse.py:
+ reads from stdin the sanitized syslog file and prints a valid dot file
+ from the given output.
+ The parser module may also produce any other output (e.g. for dns
+ entries and so on) you will need to actually read and modify the source
+ in order to be able to do this. ~May the source be with you~
+