git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #115185 from Ma27/knot-exporter

prometheus-knot-exporter: init at 2021-01-30; minor module improvements

commit3ceef8186cc4e70149c23e21ffb85ecccbce10aa authorWilliButz <WilliButz@users.noreply.github.com> dateThu 11 Mar 2021, 18:58 (6 years ago) parenta72148fc62eef5
5 files changed+124−8
nixos/modules/services/monitoring/prometheus/exporters.nix+16−8 nixos/modules/services/monitoring/prometheus/exporters/knot.nix+50 nixos/tests/prometheus-exporters.nix+18 pkgs/servers/monitoring/prometheus/knot-exporter.nix+39 pkgs/top-level/all-packages.nix+1
nixos/modules/services/monitoring/prometheus/exporters.nix+16−8
@@ -3,7 +3,7 @@
33let
44 inherit (lib) concatStrings foldl foldl' genAttrs literalExample maintainers
55 mapAttrsToList mkDefault mkEnableOption mkIf mkMerge mkOption
6− optional types;
6+ optional types mkOptionDefault flip attrNames;
77
88 cfg = config.services.prometheus.exporters;
99
@@ -32,6 +32,7 @@ let
3232 "fritzbox"
3333 "json"
3434 "keylight"
35+ "knot"
3536 "lnd"
3637 "mail"
3738 "mikrotik"
@@ -65,7 +66,7 @@ let
6566 mkExporterOpts = ({ name, port }: {
6667 enable = mkEnableOption "the prometheus ${name} exporter";
6768 port = mkOption {
68− type = types.int;
69+ type = types.port;
6970 default = port;
7071 description = ''
7172 Port to listen on.
@@ -93,9 +94,8 @@ let
9394 '';
9495 };
9596 firewallFilter = mkOption {
96− type = types.str;
97− default = "-p tcp -m tcp --dport ${toString cfg.${name}.port}";
98− defaultText = "-p tcp -m tcp --dport ${toString port}";
97+ type = types.nullOr types.str;
98+ default = null;
9999 example = literalExample ''
100100 "-i eth0 -p tcp -m tcp --dport ${toString port}"
101101 '';
@@ -123,12 +123,14 @@ let
123123
124124 mkSubModule = { name, port, extraOpts, imports }: {
125125 ${name} = mkOption {
126− type = types.submodule {
126+ type = types.submodule [{
127127 inherit imports;
128128 options = (mkExporterOpts {
129129 inherit name port;
130130 } // extraOpts);
131− };
131+ } ({ config, ... }: mkIf config.openFirewall {
132+ firewallFilter = mkOptionDefault "-p tcp -m tcp --dport ${toString config.port}";
133+ })];
132134 internal = true;
133135 default = {};
134136 };
@@ -233,7 +235,13 @@ in
233235 Please specify either 'services.prometheus.exporters.sql.configuration' or
234236 'services.prometheus.exporters.sql.configFile'
235237 '';
236− } ];
238+ } ] ++ (flip map (attrNames cfg) (exporter: {
239+ assertion = cfg.${exporter}.firewallFilter != null -> cfg.${exporter}.openFirewall;
240+ message = ''
241+ The `firewallFilter'-option of exporter ${exporter} doesn't have any effect unless
242+ `openFirewall' is set to `true'!
243+ '';
244+ }));
237245 }] ++ [(mkIf config.services.minio.enable {
238246 services.prometheus.exporters.minio.minioAddress = mkDefault "http://localhost:9000";
239247 services.prometheus.exporters.minio.minioAccessKey = mkDefault config.services.minio.accessKey;
nixos/modules/services/monitoring/prometheus/exporters/knot.nixnew file+50
@@ -0,0 +1,50 @@
1+{ config, lib, pkgs, options }:
2+
3+with lib;
4+
5+let
6+ cfg = config.services.prometheus.exporters.knot;
7+in {
8+ port = 9433;
9+ extraOpts = {
10+ knotLibraryPath = mkOption {
11+ type = types.str;
12+ default = "${pkgs.knot-dns.out}/lib/libknot.so";
13+ defaultText = "\${pkgs.knot-dns}/lib/libknot.so";
14+ description = ''
15+ Path to the library of <package>knot-dns</package>.
16+ '';
17+ };
18+
19+ knotSocketPath = mkOption {
20+ type = types.str;
21+ default = "/run/knot/knot.sock";
22+ description = ''
23+ Socket path of <citerefentry><refentrytitle>knotd</refentrytitle>
24+ <manvolnum>8</manvolnum></citerefentry>.
25+ '';
26+ };
27+
28+ knotSocketTimeout = mkOption {
29+ type = types.int;
30+ default = 2000;
31+ description = ''
32+ Timeout in seconds.
33+ '';
34+ };
35+ };
36+ serviceOpts = {
37+ serviceConfig = {
38+ ExecStart = ''
39+ ${pkgs.prometheus-knot-exporter}/bin/knot_exporter \
40+ --web-listen-addr ${cfg.listenAddress} \
41+ --web-listen-port ${toString cfg.port} \
42+ --knot-library-path ${cfg.knotLibraryPath} \
43+ --knot-socket-path ${cfg.knotSocketPath} \
44+ --knot-socket-timeout ${toString cfg.knotSocketTimeout} \
45+ ${concatStringsSep " \\\n " cfg.extraFlags}
46+ '';
47+ SupplementaryGroups = [ "knot" ];
48+ };
49+ };
50+}
nixos/tests/prometheus-exporters.nix+18
@@ -263,6 +263,24 @@ let
263263 '';
264264 };
265265
266+ knot = {
267+ exporterConfig = {
268+ enable = true;
269+ };
270+ metricProvider = {
271+ services.knot = {
272+ enable = true;
273+ extraArgs = [ "-v" ];
274+ };
275+ };
276+ exporterTest = ''
277+ wait_for_unit("knot.service")
278+ wait_for_unit("prometheus-knot-exporter.service")
279+ wait_for_open_port(9433)
280+ succeed("curl -sSf 'localhost:9433' | grep -q 'knot_server_zone_count 0.0'")
281+ '';
282+ };
283+
266284 keylight = {
267285 # A hardware device is required to properly test this exporter, so just
268286 # perform a couple of basic sanity checks that the exporter is running
pkgs/servers/monitoring/prometheus/knot-exporter.nixnew file+39
@@ -0,0 +1,39 @@
1+{ stdenv, fetchFromGitHub, lib, python3, nixosTests }:
2+
3+stdenv.mkDerivation rec {
4+ pname = "knot-exporter";
5+ version = "unstable-2020-01-30";
6+
7+ src = fetchFromGitHub {
8+ owner = "ghedo";
9+ repo = "knot_exporter";
10+ rev = "21dd46b401e0c1aea0b173e19462cdf89e1f444e";
11+ sha256 = "sha256-4au4lpaq3jcqC2JXdCcf8h+YN8Nmm4eE0kZwA+1rWlc=";
12+ };
13+
14+ dontBuild = true;
15+
16+ nativeBuildInputs = [ python3.pkgs.wrapPython ];
17+ buildInputs = [ python3 ];
18+
19+ installPhase = ''
20+ runHook preInstall
21+
22+ install -Dm0755 knot_exporter $out/bin/knot_exporter
23+ patchShebangs $out/bin
24+ buildPythonPath ${python3.pkgs.prometheus_client}
25+ patchPythonScript $out/bin/knot_exporter
26+
27+ runHook postInstall
28+ '';
29+
30+ passthru.tests = { inherit (nixosTests.prometheus-exporters) knot; };
31+
32+ meta = with lib; {
33+ homepage = "https://github.com/ghedo/knot_exporter";
34+ description = " Prometheus exporter for Knot DNS";
35+ license = licenses.gpl3Only;
36+ maintainers = with maintainers; [ ma27 ];
37+ platforms = platforms.linux;
38+ };
39+}
pkgs/top-level/all-packages.nix+1
@@ -18596,6 +18596,7 @@ in
1859618596 prometheus-haproxy-exporter = callPackage ../servers/monitoring/prometheus/haproxy-exporter.nix { };
1859718597 prometheus-json-exporter = callPackage ../servers/monitoring/prometheus/json-exporter.nix { };
1859818598 prometheus-keylight-exporter = callPackage ../servers/monitoring/prometheus/keylight-exporter.nix { };
18599+ prometheus-knot-exporter = callPackage ../servers/monitoring/prometheus/knot-exporter.nix { };
1859918600 prometheus-lnd-exporter = callPackage ../servers/monitoring/prometheus/lnd-exporter.nix { };
1860018601 prometheus-mail-exporter = callPackage ../servers/monitoring/prometheus/mail-exporter.nix { };
1860118602 prometheus-mesos-exporter = callPackage ../servers/monitoring/prometheus/mesos-exporter.nix { };