diff options
author | Silvan Mosberger <infinisil@icloud.com> | 2019-01-24 00:17:20 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-24 00:17:20 +0100 |
commit | 7222fd9e21a41d4f00556700986ce5190c878f6f (patch) | |
tree | 78fdbba4b2fcd47dc6e42e769dbae8970919df96 | |
parent | f88f64365906e6c9aca5174a78046be47f8822e5 (diff) | |
parent | ca72dbd125701b348e819da027aaad35f611f725 (diff) | |
download | nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar.gz nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar.bz2 nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar.lz nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar.xz nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.tar.zst nixlib-7222fd9e21a41d4f00556700986ce5190c878f6f.zip |
Merge pull request #53986 from Ma27/document-dovecot-prometheus-exporter-issues
nixos/prometheus-dovecot-exporter: enhance `socketPath` documentation
-rw-r--r-- | nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix index 4ca6d4e5f8b6..c47e87a3dc35 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix @@ -18,12 +18,34 @@ in socketPath = mkOption { type = types.path; default = "/var/run/dovecot/stats"; - example = "/var/run/dovecot2/stats"; + example = "/var/run/dovecot2/old-stats"; description = '' Path under which the stats socket is placed. The user/group under which the exporter runs, should be able to access the socket in order to scrape the metrics successfully. + + Please keep in mind that the stats module has changed in + <link xlink:href="https://wiki2.dovecot.org/Upgrading/2.3">Dovecot 2.3+</link> which + is not <link xlink:href="https://github.com/kumina/dovecot_exporter/issues/8">compatible with this exporter</link>. + + The following extra config has to be passed to Dovecot to ensure that recent versions + work with this exporter: + <programlisting> + { + <xref linkend="opt-services.prometheus.exporters.dovecot.enable" /> = true; + <xref linkend="opt-services.prometheus.exporters.dovecot.socketPath" /> = "/var/run/dovecot2/old-stats"; + <xref linkend="opt-services.dovecot2.extraConfig" /> = ''' + mail_plugins = $mail_plugins old_stats + service old-stats { + unix_listener old-stats { + user = nobody + group = nobody + } + } + '''; + } + </programlisting> ''; }; scopes = mkOption { |