Mercurial > prosody-modules

annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
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
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
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
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
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
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
30
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
31 ## Summary
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
32
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
33 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
34
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
35 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
36 ----------------------- -------- ---------------------------
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
37 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
38 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
39 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
40 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
41
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
42 [^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
43
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
44 ## 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
45
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 `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
48 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
49
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 ``` lua
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
52 -- defaults:
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
53 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
54 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
55 ```
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
56
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
57 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
58 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
59
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
60 ## Configuring Munin
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 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
63
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
64 ``` ini
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
65 [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
66 address = 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
67 port = 4949
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
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
70 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
71 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
72
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
73 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
74 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
75 issues.
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
76
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
77 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
78 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
79 options.
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
80
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
81 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
82
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
83 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
84 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
85
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
86 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
87
4a1c1ffb4c09 mod_munin/README: Describe options and how to set up munin.conf
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
88 [muninconf]: http://guide.munin-monitoring.org/en/stable-2.0/reference/munin.conf.html