prosody-modules
tip
mod_munin/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_munin/README.md @ 6211:750d64c47ec6 draft default tip

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