Munin plugins should be symlinked, not created directly in /etc.

[cubemap] / README

diff --git a/README b/README
index a8692219df4f22ece9e19481597e76b1ed98b0f2..4e417f759b114d4106931686c500c2ebabb139dc 100644 (file)
--- a/README
+++ b/README
@@ -3,10 +3,10 @@ specifically made for use with VLC. It is currently in alpha stage.
 
 A short list of features:
 
- - High-performance. Exactly how high-performance remains to be seen,
-   but it is designed to go to 10 Gbit/sec and beyond, through a
-   design with multiple worker threads, epoll and sendfile
-   (yes, sendfile).
+ - High-performance, through a design with multiple worker threads,
+   epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
+   10 gigabit Ethernet, given a modern kernel, a modern NIC
+   and the right kernel tuning.
  - High-availability. You can change any part of the configuration
    (and even upgrade to a newer version of Cubemap) by changing cubemap.config
    and sending a SIGHUP; all clients will continue as if nothing had happened
@@ -42,6 +42,20 @@ are OK, and then exec() the new version, which deserializes everything and
 keeps going.
 
 
+Munin plugins:
+
+To activate these, symlink them into /etc/munin/plugins. If you don't put
+the files in the expected default locations (as done by 'make install'),
+you probably want some configuration in /etc/munin/plugin-conf.d/cubemap or
+similar, like this:
+
+[cubemap*]
+user <something>
+env.cubemap_config /etc/cubemap/cubemap.config
+env.cubemap_stats /var/lib/cubemap/cubemap.stats
+env.cubemap_input_stats /var/lib/cubemap/cubemap-input.stats
+
+
 Legalese: 
 
 Copyright 2013 Steinar H. Gunderson <sgunderson@bigfoot.com>.