mod_munin

Summary

This module implements the Munin reporting protocol, allowing you to collect statistics directly from Prosody into Munin.

Configuration

There is only one recommended option, munin_node_name, which specifies the name that Prosody will identify itself by to the Munin server. You may want to set this to the same hostname as in the SRV record for the machine.

modules_enabled = {
    -- your other modules
    "munin",
}

munin_node_name = "xmpp.example.com"

You will also want to enable statistics collection by setting:

statistics_interval = 300 -- every 5 minutes, same as munin

Summary

All these must be in the global section.

Option Type Default
munin_node_name string "localhost"
munin_ignored_stats set { }
munin_ports set { 4949 }
munin_interfaces set { "0.0.0.0", "::" }1

Ports and interfaces

mod_munin listens on port 4949 on all local interfaces by default. This can be changed with the standard port and network configuration:

-- defaults:
munin_ports = { 4949 }
munin_interfaces = { "::", "0.0.0.0" }

If you already have a munin-node instance running, you can set a different port to avoid the conflict.

Configuring Munin

Simply add munin_node_name surrounded by brackets to /etc/munin/munin.conf:

[xmpp.example.com]
address xmpp.example.com
port 4949

You can leave out address if it equal to the name in brackets, and leave out the port if it is the default (4949).

Setting address to an IP address may sometimes be useful as the Munin collection server is not delayed by DNS lookups in case of network issues.

If you set a different port, or if the hostname to connect to is different from this hostname, make sure to add port and/or address options.

See Munin documentation for more information.

Compatibility

Requires Prosody 0.10 or above


  1. Varies depending on availability of IPv4 and IPv6↩︎


Installation

With the plugin installer in Prosody 0.12 you can use:

sudo prosodyctl install --server=https://modules.prosody.im/rocks/ mod_munin

For earlier versions see the documentation for installing 3rd party modules