| | 1 | = Cyrus IMAPd connection statistics = |
|---|
| | 2 | |
|---|
| | 3 | == About == |
|---|
| | 4 | The [source:cyrus-imapd] plugin allows the [http://munin.projects.linpro.no/ munin] monitor to graph connection statistics of the [http://cyrusimap.web.cmu.edu/ Cyrus IMAPd] mail server. The cyrus-imapd plugin specifically charts the following values: |
|---|
| | 5 | |
|---|
| | 6 | * Number of connections |
|---|
| | 7 | * Number of authenticated users |
|---|
| | 8 | * Number of unique users |
|---|
| | 9 | |
|---|
| | 10 | The plugin works by parsing the cyrus-provided proc directory. |
|---|
| | 11 | |
|---|
| | 12 | == Screenshot == |
|---|
| | 13 | [[Image(Images:cyrus_imapd-day.png, nolink)]] |
|---|
| | 14 | |
|---|
| | 15 | == Download == |
|---|
| | 16 | [https://trac.bawue.org/munin/browser/cyrus-imapd?format=txt cyrus-imapd] |
|---|
| | 17 | |
|---|
| | 18 | == Installation == |
|---|
| | 19 | 1. Copy or link the cyrus-imapd script into your munin-node plugin directory, usually {{{/etc/munin/plugins}}}. |
|---|
| | 20 | 1. Configure the munin-node to run the cyrus-imapd plugin as user root or another user able to read the cyrus-imapd proc directory, usually {{{/var/lib/imap/proc}}}: |
|---|
| | 21 | {{{ |
|---|
| | 22 | [cyrus-imapd_*] |
|---|
| | 23 | user root |
|---|
| | 24 | }}} |
|---|
| | 25 | 1. Test the plugin by calling {{{munin-run cyrus-imapd config}}} and by executing {{{munin-run cyrus-imapd}}}. Both commands should output sensible data without failing. |
|---|
| | 26 | 1. Restart the munin-node process. |
|---|
| | 27 | |
|---|
| | 28 | == Notes == |
|---|
| | 29 | * Due to the 5min wait time between sampling, the measurement can be somewhat inaccurate. Only established connections during the munin run will be counted. Short-term connections between two runs will not be detected. |
|---|
| | 30 | * Make sure that the directory the cyrus-imapd uses to export it's runtime statistics, usually {{{/var/lib/imap/proc}}}, is cleared of any status files before starting the imap daemon. Otherwise there may be some files left from an earlier, crashed imapd process throwing the measurements off. |
|---|
| | 31 | |
|---|
| | 32 | == License == |
|---|
| | 33 | The code is available as free software under the [wiki:GPL2 GPL Version 2]. |
|---|
| | 34 | |
|---|
| | 35 | == Bugs and Contact == |
|---|
| | 36 | In case of bugs, please either [https://trac.bawue.org/munin/newticket open a ticket] in this Trac instance or write to <andreas (at) bawue (dot) net>. |
|---|
