diff --git a/README.md b/README.md index 934407ba941f649244612241c772240104059afa..cc7d638daf9800c8189aa3c695c2320a6f40c7db 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,21 @@ This repository provides a `dovecot_exporter` utility that can be used to scrape statistics from Dovecot and export them as Prometheus metrics. It extracts the metrics that are exposed by [Dovecot's stats module](https://wiki2.dovecot.org/Statistics/Old) by -connecting to UNIX socket `/var/run/dovecot/stats` and serves them as +connecting to UNIX socket `/var/run/dovecot/stats-exporter` and serves them as Prometheus metrics over TCP port 9166. +The socket will be created with the appropriate permissions by this Dovecot +configuration: + +``` +service stats { + fifo_listener stats-exporter { + user = dovecot + mode = 0600 + } +} +``` + A list of command line flags supported by this utility can be obtained by looking at this exporter's `main()` function. Do note that all command line flags require two leading dashes (e.g., diff --git a/debian/dovecot-exporter.default b/debian/dovecot-exporter.default index 6e6a481390ad8b94dc4edf45d03fe5cfb21a3738..fca076a0eb27053a0b8cc3032f59ad01c8233fd3 100644 --- a/debian/dovecot-exporter.default +++ b/debian/dovecot-exporter.default @@ -1,3 +1,3 @@ ADDR=:9166 SCOPES=global -DOVECOT_SOCKET=/var/run/dovecot/old-stats +DOVECOT_SOCKET=/var/run/dovecot/stats-exporter diff --git a/dovecot_exporter.go b/dovecot_exporter.go index 6f614cfc86dda981f7b8d2ba927d9da2bbc386ec..127211dfb2f2727ef8ec9270937dff4e9a39924a 100644 --- a/dovecot_exporter.go +++ b/dovecot_exporter.go @@ -208,7 +208,7 @@ func main() { app = kingpin.New("dovecot_exporter", "Prometheus metrics exporter for Dovecot") listenAddress = app.Flag("web.listen-address", "Address to listen on for web interface and telemetry.").Default(":9166").String() metricsPath = app.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").String() - socketPath = app.Flag("dovecot.socket-path", "Path under which to expose metrics.").Default("/var/run/dovecot/stats").String() + socketPath = app.Flag("dovecot.socket-path", "Path under which to expose metrics.").Default("/var/run/dovecot/stats-exporter").String() dovecotScopes = app.Flag("dovecot.scopes", "Stats scopes to query (comma separated)").Default("user").String() ) kingpin.MustParse(app.Parse(os.Args[1:]))