Ian S. Pringle 046eb3dd8c Updated README

- Previously the README directed readers to look inside of `main.go` in
  order to see the various flags. I found this to be unacceptable and I
  have updated the README with flags from both `main.go` and
  `systemd.go` I could not find any further flags however I could be
  missing something.
- Updated the description in the README to be less verbose.

2020-05-15 08:24:11 -04:00

2.7 KiB

Raw Blame History

Prometheus Postfix exporter

Prometheus metrics exporter for the Postfix mail server. 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. It also 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.

Options

These options can be used when starting the postfix_exporter

Flag	Description	Default
`--web.listen-address`	Address to listen on for web interface and telemetry	`9154`
`--web.telemetry-path`	Path under which to expose metrics	`/metrics`
`--postfix.showq_path`	Path at which Postfix places its showq socket	`/var/spool/postfix/public/showq`
`--postfix.logfile_path`	Path where Postfix writes log entries	`/var/log/maillog`
`--log.unsupported`	Log all unsupported lines	`false`
`--systemd.enable`	Read from the systemd journal instead of log	`false`
`--systemd.unit`	Name of the Postfix systemd unit	`postfix.service`
`--systemd.slice`	Name of the Postfix systemd slice.	`""`
`--systemd.journal_path`	Path to the systemd journal	`""`

Events from log file

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 --postfix.logfile_path flag.

Events from systemd

Retrieval from the systemd journal is enabled with the --systemd.enable flag. This overrides the log file setting. 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.

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