git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #99079 from mayflower/openvpn-exporter-upstream

nixos/prometheus-exporters/openvpn: init

commit6148b0e59f972fbab0818c06b2749b6c772e5d90 authorMaximilian Bosch <maximilian@mbosch.me> dateWed 30 Sep 2020, 15:37 (6 years ago) parentae94ce8a560936
3 files changed+66−4
nixos/modules/services/monitoring/prometheus/exporters.nix+2−4 nixos/modules/services/monitoring/prometheus/exporters/openvpn.nix+39 nixos/tests/prometheus-exporters.nix+25
nixos/modules/services/monitoring/prometheus/exporters.nix+2−4
@@ -38,6 +38,7 @@ let
3838 "nextcloud"
3939 "nginx"
4040 "node"
41+ "openvpn"
4142 "postfix"
4243 "postgres"
4344 "redis"
@@ -101,7 +102,6 @@ let
101102 default = "${name}-exporter";
102103 description = ''
103104 User name under which the ${name} exporter shall be run.
104− Has no effect when <option>systemd.services.prometheus-${name}-exporter.serviceConfig.DynamicUser</option> is true.
105105 '';
106106 };
107107 group = mkOption {
@@ -109,7 +109,6 @@ let
109109 default = "${name}-exporter";
110110 description = ''
111111 Group under which the ${name} exporter shall be run.
112− Has no effect when <option>systemd.services.prometheus-${name}-exporter.serviceConfig.DynamicUser</option> is true.
113112 '';
114113 };
115114 });
@@ -161,10 +160,9 @@ let
161160 serviceConfig.PrivateTmp = mkDefault true;
162161 serviceConfig.WorkingDirectory = mkDefault /tmp;
163162 serviceConfig.DynamicUser = mkDefault enableDynamicUser;
164− } serviceOpts ] ++ optional (!enableDynamicUser) {
165163 serviceConfig.User = conf.user;
166164 serviceConfig.Group = conf.group;
167− });
165+ } serviceOpts ]);
168166 };
169167in
170168{
nixos/modules/services/monitoring/prometheus/exporters/openvpn.nixnew file+39
@@ -0,0 +1,39 @@
1+{ config, pkgs, lib, ... }:
2+
3+with lib;
4+
5+let
6+ cfg = config.services.prometheus.exporters.openvpn;
7+in {
8+ port = 9176;
9+ extraOpts = {
10+ statusPaths = mkOption {
11+ type = types.listOf types.str;
12+ description = ''
13+ Paths to OpenVPN status files. Please configure the OpenVPN option
14+ <literal>status</literal> accordingly.
15+ '';
16+ };
17+ telemetryPath = mkOption {
18+ type = types.str;
19+ default = "/metrics";
20+ description = ''
21+ Path under which to expose metrics.
22+ '';
23+ };
24+ };
25+
26+ serviceOpts = {
27+ serviceConfig = {
28+ PrivateDevices = true;
29+ ProtectKernelModules = true;
30+ NoNewPrivileges = true;
31+ ExecStart = ''
32+ ${pkgs.prometheus-openvpn-exporter}/bin/openvpn_exporter \
33+ -openvpn.status_paths "${concatStringsSep "," cfg.statusPaths}" \
34+ -web.listen-address ${cfg.listenAddress}:${toString cfg.port} \
35+ -web.telemetry-path ${cfg.telemetryPath}
36+ '';
37+ };
38+ };
39+}
nixos/tests/prometheus-exporters.nix+25
@@ -457,6 +457,31 @@ let
457457 '';
458458 };
459459
460+ openvpn = {
461+ exporterConfig = {
462+ enable = true;
463+ group = "openvpn";
464+ statusPaths = ["/run/openvpn-test"];
465+ };
466+ metricProvider = {
467+ users.groups.openvpn = {};
468+ services.openvpn.servers.test = {
469+ config = ''
470+ dev tun
471+ status /run/openvpn-test
472+ status-version 3
473+ '';
474+ up = "chmod g+r /run/openvpn-test";
475+ };
476+ systemd.services."openvpn-test".serviceConfig.Group = "openvpn";
477+ };
478+ exporterTest = ''
479+ wait_for_unit("openvpn-test.service")
480+ wait_for_unit("prometheus-openvpn-exporter.service")
481+ succeed("curl -sSf http://localhost:9176/metrics | grep -q 'openvpn_up{.*} 1'")
482+ '';
483+ };
484+
460485 postfix = {
461486 exporterConfig = {
462487 enable = true;