Monitoring

Cyrus IMAP supports monitoring using Prometheus.

To use this functionality, Cyrus IMAP must have been built with the --enable-http configure option enabled.

Setup

• Set prometheus_enabled option to "yes"

• Add the prometheus module to your httpmodules

• Set the prometheus_need_auth, prometheus_service_update_freq, prometheus_master_update_freq, prometheus_usage_update_freq, and prometheus_stats_dir settings to taste

• Add a job to run promstatsd(8) to the DAEMON section of cyrus.conf(5) (the actual daemon process)

• Add a job to run promstatsd -c to the START section of 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

• prometheus_enabled

• prometheus_need_auth

• prometheus_service_update_freq

• prometheus_master_update_freq

• prometheus_usage_update_freq

• prometheus_stats_dir

Back to Administrator Guide