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