aboutsummaryrefslogtreecommitdiffstats
path: root/syslog_munin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'syslog_munin/README.md')
-rw-r--r--syslog_munin/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/syslog_munin/README.md b/syslog_munin/README.md
new file mode 100644
index 0000000..cc0580b
--- /dev/null
+++ b/syslog_munin/README.md
@@ -0,0 +1,21 @@
+Overview
+--------
+
+This folder contains a helper tool that
+monitors syslog and counts warnings and errors
+for munin to plot.
+
+Setup
+-----
+
+ # Configure your syslog daemon to send messages from
+ local0 (the facility the ODR-mmbTools log to)
+ to localhost:51400 over UDP
+ # Use supervisord or similar to run the service *syslog_munin.py*
+ # Copy *syslog_munin_plugin.sh* to */etc/munin/plugins/*
+ # Wait for munin to start graphing
+
+Todo
+----
+
+ * Define alert thresholds in the config descriptor.