mod_munin/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Beta'
   4 summary: Implementation of the Munin node protocol
   5 ...
   6
   7 Summary
   8 =======
   9
  10 This module implements the Munin reporting protocol, allowing you to
  11 collect statistics directly from Prosody into Munin.
  12
  13 Configuration
  14 =============
  15
  16 There is only one recommended option, `munin_node_name`, which specifies
  17 the name that Prosody will identify itself by to the Munin server. You
  18 may want to set this to the same hostname as in the [SRV record][doc:dns]
  19 for the machine.
  20
  21 ```lua
  22 modules_enabled = {
  23     -- your other modules
  24     "munin",
  25 }
  26
  27 munin_node_name = "xmpp.example.com"
  28 ```
  29
  30 You will also want to enable statistics collection by setting:
  31
  32 ```lua
  33 statistics_interval = 300 -- every 5 minutes, same as munin
  34 ```
  35
  36 ## Summary
  37
  38 All these must be in [the global section][doc:configure#overview].
  39
  40   Option                  Type     Default
  41   ----------------------- -------- ---------------------------
  42   munin\_node\_name       string   `"localhost"`
  43   munin\_ignored\_stats   set      `{ }`
  44   munin\_ports            set      `{ 4949 }`
  45   munin\_interfaces       set      `{ "0.0.0.0", "::" }`[^1]
  46
  47 [^1]: Varies depending on availability of IPv4 and IPv6
  48
  49 ## Ports and interfaces
  50
  51
  52 `mod_munin` listens on port `4949` on all local interfaces by default.
  53 This can be changed with the standard [port and network configuration][doc:ports]:
  54
  55
  56 ``` lua
  57 -- defaults:
  58 munin_ports = { 4949 }
  59 munin_interfaces = { "::", "0.0.0.0" }
  60 ```
  61
  62 If you already have a `munin-node` instance running, you can set a
  63 different port to avoid the conflict.
  64
  65 ## Configuring Munin
  66
  67 Simply add `munin_node_name` surrounded by brackets to `/etc/munin/munin.conf`:
  68
  69 ``` ini
  70 [xmpp.example.com]
  71 address xmpp.example.com
  72 port 4949
  73 ```
  74
  75 You can leave out `address` if it equal to the name in brackets, and
  76 leave out the `port` if it is the default (`4949`).
  77
  78 Setting `address` to an IP address may sometimes be useful as the Munin
  79 collection server is not delayed by DNS lookups in case of network
  80 issues.
  81
  82 If you set a different port, or if the hostname to connect to is
  83 different from this hostname, make sure to add `port` and/or `address`
  84 options.
  85
  86 See [Munin documentation][muninconf] for more information.
  87
  88 Compatibility
  89 =============
  90
  91 **Requires** Prosody 0.10 or above
  92
  93 [muninconf]: http://guide.munin-monitoring.org/en/stable-2.0/reference/munin.conf.html