1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
.. _imap-admin-monitoring:
==========
Monitoring
==========
Cyrus IMAP supports monitoring using Prometheus_.
To use this functionality, Cyrus IMAP must have been built with the
``--enable-http`` configure option enabled.
.. _imap-admin-monitoring-setup:
Setup
=====
* Set the `prometheus_enabled` setting in :cyrusman:`imapd.conf(5)` to "yes"
* Add the `prometheus` module to your `httpmodules` in :cyrusman:`imapd.conf(5)`
* Set the `prometheus_need_auth`, `prometheus_update_freq` and `prometheus_stats_dir`
settings in :cyrusman:`imapd.conf(5)` to taste
* Add a job to run :cyrusman:`promstatsd(8)` to the DAEMON section of
:cyrusman:`cyrus.conf(5)` (the actual daemon process)
* Add a job to run ``promstatsd -c`` to the START section of :cyrusman:`cyrus.conf(5)`
(this cleans up the stats files from the previous run)
* Configure your Prometheus server to scrape http://yourserver.example.com/metrics
Configuration options
=====================
.. include:: /imap/reference/manpages/configs/imapd.conf.rst
:start-after: startblob prometheus_enabled
:end-before: endblob prometheus_enabled
.. include:: /imap/reference/manpages/configs/imapd.conf.rst
:start-after: startblob prometheus_need_auth
:end-before: endblob prometheus_need_auth
.. include:: /imap/reference/manpages/configs/imapd.conf.rst
:start-after: startblob prometheus_update_freq
:end-before: endblob prometheus_update_freq
.. include:: /imap/reference/manpages/configs/imapd.conf.rst
:start-after: startblob prometheus_stats_dir
:end-before: endblob prometheus_stats_dir
.. _imap-admin-monitoring-end:
Back to :ref:`imap-admin`
.. _Prometheus: https://prometheus.io
|
