locker98/postfix_exporter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README

Browse Source 
- 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.
This commit is contained in:
Ian S. Pringle 2020-05-15 08:23:59 -04:00
parent b0b31e3bab
commit 046eb3dd8c
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,17 +1,27 @@
# Prometheus Postfix exporter # Prometheus Postfix exporter
This repository provides code for a Prometheus metrics exporter Prometheus metrics exporter for [the Postfix mail server](http://www.postfix.org/).
for [the Postfix mail server](http://www.postfix.org/). This exporter This exporter provides histogram metrics for the size and age of messages stored in
provides histogram metrics for the size and age of messages stored in
the mail queue. It extracts these metrics from Postfix by connecting to the mail queue. It extracts these metrics from Postfix by connecting to
a UNIX socket under `/var/spool`. 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.
In addition to that, it counts events by parsing Postfix's log entries, ## Options
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 These options can be used when starting the `postfix_exporter`
command line flags.
| 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 ## Events from log file