Mercurial > prosody-modules

comparison mod_munin/README.markdown @ 2009:4a1c1ffb4c09

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_munin/README: Describe options and how to set up munin.conf
author Kim Alvefur <zash@zash.se>
date Fri, 15 Jan 2016 16:49:23 +0100
parents 4d73a1a6ba68
children 891a5e925ae5
comparison
equal deleted inserted replaced
2008:cf3bdcb633f0 2009:4a1c1ffb4c09
8 ======= 8 =======
9 9
10 This module implements the Munin reporting protocol, allowing you to 10 This module implements the Munin reporting protocol, allowing you to
11 collect statistics directly from Prosody into Munin. 11 collect statistics directly from Prosody into Munin.
12 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
31 ## Summary
32
33 All these must be in [the global section][doc:configure#overview].
34
35 Option Type Default
36 ----------------------- -------- ---------------------------
37 munin\_node\_name string `"localhost"`
38 munin\_ignored\_stats set `{ }`
39 munin\_ports set `{ 4949 }`
40 munin\_interfaces set `{ "0.0.0.0", "::" }`[^1]
41
42 [^1]: Varies depending on availability of IPv4 and IPv6
43
44 ## Ports and interfaces
45
46
47 `mod_munin` listens on port `4949` on all local interfaces by default.
48 This can be changed with the standard [port and network configuration][doc:ports]:
49
50
51 ``` lua
52 -- defaults:
53 munin_ports = { 4949 }
54 munin_interfaces = { "::", "0.0.0.0" }
55 ```
56
57 If you already have a `munin-node` instance running, you can set a
58 different port to avoid the conflict.
59
60 ## Configuring Munin
61
62 Simply add `munin_node_name` surrounded by brackets to `/etc/munin/munin.conf`:
63
64 ``` ini
65 [xmpp.example.com]
66 address = xmpp.example.com
67 port = 4949
68 ```
69
70 You can leave out `address` if it equal to the name in brackets, and
71 leave out the `port` if it is the default (`4949`).
72
73 Setting `address` to an IP address may sometimes be useful as the Munin
74 collection server is not delayed by DNS lookups in case of network
75 issues.
76
77 If you set a different port, or if the hostname to connect to is
78 different from this hostname, make sure to add `port` and/or `address`
79 options.
80
81 See [Munin documentation][muninconf] for more information.
82
13 Compatibility 83 Compatibility
14 ============= 84 =============
15 85
16 Requires Prosody 0.10 or above 86 Requires Prosody 0.10 or above
87
88 [muninconf]: http://guide.munin-monitoring.org/en/stable-2.0/reference/munin.conf.html