2017-02-17 15:04:32 +00:00
|
|
|
# Prometheus Postfix exporter
|
|
|
|
|
|
2017-05-02 13:07:19 +00:00
|
|
|
This repository provides code for a Prometheus metrics exporter
|
|
|
|
|
for [the Postfix mail server](http://www.postfix.org/). This exporter
|
|
|
|
|
provides histogram metrics for the size and age of messages stored in
|
|
|
|
|
the mail queue. It extracts these metrics from Postfix by connecting to
|
|
|
|
|
a UNIX socket under `/var/spool`.
|
|
|
|
|
|
2018-02-13 10:15:04 +00:00
|
|
|
In addition to that, it counts events by parsing Postfix's log entries,
|
|
|
|
|
using regular expression matching.
|
|
|
|
|
The log entries are retrieved from the systemd journal or from a log file.
|
|
|
|
|
|
|
|
|
|
Please refer to this utility's `main()` function for a list of supported
|
|
|
|
|
command line flags.
|
|
|
|
|
|
|
|
|
|
## Events from log file
|
|
|
|
|
|
2018-09-30 22:16:10 +00:00
|
|
|
The log file is tailed when processed. Rotating the log files while the exporter
|
|
|
|
|
is running is OK. The path to the log file is specified with the
|
2019-02-15 11:41:28 +00:00
|
|
|
`--postfix.logfile_path` flag.
|
2018-02-02 10:51:33 +00:00
|
|
|
|
2018-02-13 10:15:04 +00:00
|
|
|
## Events from systemd
|
2018-02-02 10:51:33 +00:00
|
|
|
|
2019-02-15 11:41:28 +00:00
|
|
|
Retrieval from the systemd journal is enabled with the `--systemd.enable` flag.
|
2018-02-13 10:15:04 +00:00
|
|
|
This overrides the log file setting.
|
2019-02-15 11:41:28 +00:00
|
|
|
It is possible to specify the unit (with `--systemd.unit`) or slice (with `--systemd.slice`).
|
|
|
|
|
Additionally, it is possible to read the journal from a directory with the `--systemd.journal_path` flag.
|
2018-05-04 10:22:34 +00:00
|
|
|
|
|
|
|
|
## Build options
|
|
|
|
|
|
|
|
|
|
Default the exporter is build with systemd journal functionality (but it is disabled at default).
|
|
|
|
|
Because the systemd headers are required for building with systemd, there is
|
|
|
|
|
an option to build the exporter without systemd. Use the build tag `nosystemd`.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
go build -tags nosystemd
|
|
|
|
|
```
|
