From ce7608d6e7cac1b6c616b9ef0dc7c4c838ff547b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20G=C3=BCntner?= <code@mguentner.de>
Date: Thu, 10 Dec 2020 21:27:51 +0100
Subject: [PATCH 1/2] nginxlog-exporter: 1.3.0 -> 1.8.0
---
.../prometheus/nginxlog-exporter.nix | 14 +-
.../prometheus/nginxlog-exporter_deps.nix | 282 ------------------
2 files changed, 7 insertions(+), 289 deletions(-)
delete mode 100644 pkgs/servers/monitoring/prometheus/nginxlog-exporter_deps.nix
diff --git a/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix b/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
index 2c2fabf2357d..a9276e0c924a 100644
--- a/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
+++ b/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
@@ -1,21 +1,21 @@
-{ stdenv, buildGoPackage, fetchFromGitHub }:
+{ stdenv, buildGoModule, fetchFromGitHub }:
-buildGoPackage rec {
+buildGoModule rec {
pname = "nginxlog_exporter";
- version = "1.3.0";
+ version = "1.8.0";
src = fetchFromGitHub {
owner = "martin-helmich";
repo = "prometheus-nginxlog-exporter";
rev = "v${version}";
- sha256 = "0cma6hgagqdms6x40v0q4jn8gjq1awyg1aqk5l8mz7l6k132qq7k";
+ sha256 = "1kqyjw5yqgjb8xa5irdhpqvwp1qhba6igpc23n2qljhbh0aybkbq";
};
- goPackagePath = "github.com/martin-helmich/prometheus-nginxlog-exporter";
+ vendorSha256 = "130hq19y890amxhjywg5blassl8br2p9d62aai8fj839p3p2a7zp";
- goDeps = ./nginxlog-exporter_deps.nix;
+ subPackages = [ "." ];
- doCheck = true;
+ runVend = true;
meta = with stdenv.lib; {
description = "Export metrics from Nginx access log files to Prometheus";
diff --git a/pkgs/servers/monitoring/prometheus/nginxlog-exporter_deps.nix b/pkgs/servers/monitoring/prometheus/nginxlog-exporter_deps.nix
deleted file mode 100644
index 3051258a6361..000000000000
--- a/pkgs/servers/monitoring/prometheus/nginxlog-exporter_deps.nix
+++ /dev/null
@@ -1,282 +0,0 @@
-# file generated from go.mod using vgo2nix (https://github.com/adisbladis/vgo2nix)
-[
- {
- goPackagePath = "github.com/armon/go-radix";
- fetch = {
- type = "git";
- url = "https://github.com/armon/go-radix";
- rev = "v1.0.0";
- sha256 = "1m1k0jz9gjfrk4m7hjm7p03qmviamfgxwm2ghakqxw3hdds8v503";
- };
- }
- {
- goPackagePath = "github.com/beorn7/perks";
- fetch = {
- type = "git";
- url = "https://github.com/beorn7/perks";
- rev = "3ac7bf7a47d1";
- sha256 = "1qc3l4r818xpvrhshh1sisc5lvl9479qspcfcdbivdyh0apah83r";
- };
- }
- {
- goPackagePath = "github.com/davecgh/go-spew";
- fetch = {
- type = "git";
- url = "https://github.com/davecgh/go-spew";
- rev = "v1.1.1";
- sha256 = "0hka6hmyvp701adzag2g26cxdj47g21x6jz4sc6jjz1mn59d474y";
- };
- }
- {
- goPackagePath = "github.com/fsnotify/fsnotify";
- fetch = {
- type = "git";
- url = "https://github.com/fsnotify/fsnotify";
- rev = "v1.4.7";
- sha256 = "07va9crci0ijlivbb7q57d2rz9h27zgn2fsm60spjsqpdbvyrx4g";
- };
- }
- {
- goPackagePath = "github.com/golang/protobuf";
- fetch = {
- type = "git";
- url = "https://github.com/golang/protobuf";
- rev = "0c1f6d65b5a1";
- sha256 = "1ad3zv0s3swslfwmk0wry9qbjz596689z13f2s7d9gska6msigsl";
- };
- }
- {
- goPackagePath = "github.com/gopherjs/gopherjs";
- fetch = {
- type = "git";
- url = "https://github.com/gopherjs/gopherjs";
- rev = "0766667cb4d1";
- sha256 = "13pfc9sxiwjky2lm1xb3i3lcisn8p6mgjk2d927l7r92ysph8dmw";
- };
- }
- {
- goPackagePath = "github.com/hashicorp/consul";
- fetch = {
- type = "git";
- url = "https://github.com/hashicorp/consul";
- rev = "de080672fee9";
- sha256 = "1q46gn7gv7ara21akkbyzlnari4naxax2d0z917y56ra4lwm259i";
- };
- }
- {
- goPackagePath = "github.com/hashicorp/go-msgpack";
- fetch = {
- type = "git";
- url = "https://github.com/hashicorp/go-msgpack";
- rev = "v0.5.3";
- sha256 = "00jv0ajqd58pkb2yyhlrjp0rv1mvb1ijx3yqjyikcmzvk9jb4h5m";
- };
- }
- {
- goPackagePath = "github.com/hashicorp/golang-lru";
- fetch = {
- type = "git";
- url = "https://github.com/hashicorp/golang-lru";
- rev = "v0.5.1";
- sha256 = "13f870cvk161bzjj6x41l45r5x9i1z9r2ymwmvm7768kg08zznpy";
- };
- }
- {
- goPackagePath = "github.com/hashicorp/hcl";
- fetch = {
- type = "git";
- url = "https://github.com/hashicorp/hcl";
- rev = "v1.0.0";
- sha256 = "0q6ml0qqs0yil76mpn4mdx4lp94id8vbv575qm60jzl1ijcl5i66";
- };
- }
- {
- goPackagePath = "github.com/hpcloud/tail";
- fetch = {
- type = "git";
- url = "https://github.com/hpcloud/tail";
- rev = "v1.0.0";
- sha256 = "1njpzc0pi1acg5zx9y6vj9xi6ksbsc5d387rd6904hy6rh2m6kn0";
- };
- }
- {
- goPackagePath = "github.com/jtolds/gls";
- fetch = {
- type = "git";
- url = "https://github.com/jtolds/gls";
- rev = "v4.20.0";
- sha256 = "1k7xd2q2ysv2xsh373qs801v6f359240kx0vrl0ydh7731lngvk6";
- };
- }
- {
- goPackagePath = "github.com/kr/pretty";
- fetch = {
- type = "git";
- url = "https://github.com/kr/pretty";
- rev = "v0.1.0";
- sha256 = "18m4pwg2abd0j9cn5v3k2ksk9ig4vlwxmlw9rrglanziv9l967qp";
- };
- }
- {
- goPackagePath = "github.com/kr/pty";
- fetch = {
- type = "git";
- url = "https://github.com/kr/pty";
- rev = "v1.1.1";
- sha256 = "0383f0mb9kqjvncqrfpidsf8y6ns5zlrc91c6a74xpyxjwvzl2y6";
- };
- }
- {
- goPackagePath = "github.com/kr/text";
- fetch = {
- type = "git";
- url = "https://github.com/kr/text";
- rev = "v0.1.0";
- sha256 = "1gm5bsl01apvc84bw06hasawyqm4q84vx1pm32wr9jnd7a8vjgj1";
- };
- }
- {
- goPackagePath = "github.com/matttproud/golang_protobuf_extensions";
- fetch = {
- type = "git";
- url = "https://github.com/matttproud/golang_protobuf_extensions";
- rev = "v1.0.1";
- sha256 = "1d0c1isd2lk9pnfq2nk0aih356j30k3h1gi2w0ixsivi5csl7jya";
- };
- }
- {
- goPackagePath = "github.com/pmezard/go-difflib";
- fetch = {
- type = "git";
- url = "https://github.com/pmezard/go-difflib";
- rev = "v1.0.0";
- sha256 = "0c1cn55m4rypmscgf0rrb88pn58j3ysvc2d0432dp3c6fqg6cnzw";
- };
- }
- {
- goPackagePath = "github.com/prometheus/client_golang";
- fetch = {
- type = "git";
- url = "https://github.com/prometheus/client_golang";
- rev = "5636dc67ae77";
- sha256 = "0fb4w52zp0jk8218gwk4wgbhpj7d4hp6n00dvm8s0ajbysbx524d";
- };
- }
- {
- goPackagePath = "github.com/prometheus/client_model";
- fetch = {
- type = "git";
- url = "https://github.com/prometheus/client_model";
- rev = "fa8ad6fec335";
- sha256 = "11a7v1fjzhhwsl128znjcf5v7v6129xjgkdpym2lial4lac1dhm9";
- };
- }
- {
- goPackagePath = "github.com/prometheus/common";
- fetch = {
- type = "git";
- url = "https://github.com/prometheus/common";
- rev = "4402f4e5ea79";
- sha256 = "1nskicw0k0kay9dqg8hw2clgcnvjfcz839rijvrz4wh7gl42qiag";
- };
- }
- {
- goPackagePath = "github.com/prometheus/procfs";
- fetch = {
- type = "git";
- url = "https://github.com/prometheus/procfs";
- rev = "abf152e5f3e9";
- sha256 = "0cp8lznv1b4zhi3wnbjkfxwzhkqd3wbmiy6mwgjanip8l9l3ykws";
- };
- }
- {
- goPackagePath = "github.com/satyrius/gonx";
- fetch = {
- type = "git";
- url = "https://github.com/satyrius/gonx";
- rev = "47c52b995fe5";
- sha256 = "0f0b6ac9xlai168d32zas4v2afk5b2q1bs0qi3dykkk6lhq7b58m";
- };
- }
- {
- goPackagePath = "github.com/smartystreets/assertions";
- fetch = {
- type = "git";
- url = "https://github.com/smartystreets/assertions";
- rev = "b2de0cb4f26d";
- sha256 = "1i7ldgavgl35c7gk25p7bvdr282ckng090zr4ch9mk1705akx09y";
- };
- }
- {
- goPackagePath = "github.com/smartystreets/goconvey";
- fetch = {
- type = "git";
- url = "https://github.com/smartystreets/goconvey";
- rev = "200a235640ff";
- sha256 = "08hgfwjs5zqwsx1z5ja15d0g4glprb3ck7dfi88kwv5q5fl1p139";
- };
- }
- {
- goPackagePath = "github.com/stretchr/objx";
- fetch = {
- type = "git";
- url = "https://github.com/stretchr/objx";
- rev = "v0.1.0";
- sha256 = "19ynspzjdynbi85xw06mh8ad5j0qa1vryvxjgvbnyrr8rbm4vd8w";
- };
- }
- {
- goPackagePath = "github.com/stretchr/testify";
- fetch = {
- type = "git";
- url = "https://github.com/stretchr/testify";
- rev = "v1.4.0";
- sha256 = "187i5g88sxfy4vxpm7dw1gwv29pa2qaq475lxrdh5livh69wqfjb";
- };
- }
- {
- goPackagePath = "golang.org/x/sys";
- fetch = {
- type = "git";
- url = "https://go.googlesource.com/sys";
- rev = "c200b10b5d5e";
- sha256 = "1f764m3q05q2dq1pdms07jcixw4xakqw46w1djrmbhjmd9q8b0av";
- };
- }
- {
- goPackagePath = "gopkg.in/check.v1";
- fetch = {
- type = "git";
- url = "https://gopkg.in/check.v1";
- rev = "788fd7840127";
- sha256 = "0v3bim0j375z81zrpr5qv42knqs0y2qv2vkjiqi5axvb78slki1a";
- };
- }
- {
- goPackagePath = "gopkg.in/fsnotify.v1";
- fetch = {
- type = "git";
- url = "https://gopkg.in/fsnotify.v1";
- rev = "v1.4.7";
- sha256 = "07va9crci0ijlivbb7q57d2rz9h27zgn2fsm60spjsqpdbvyrx4g";
- };
- }
- {
- goPackagePath = "gopkg.in/tomb.v1";
- fetch = {
- type = "git";
- url = "https://gopkg.in/tomb.v1";
- rev = "dd632973f1e7";
- sha256 = "1lqmq1ag7s4b3gc3ddvr792c5xb5k6sfn0cchr3i2s7f1c231zjv";
- };
- }
- {
- goPackagePath = "gopkg.in/yaml.v2";
- fetch = {
- type = "git";
- url = "https://gopkg.in/yaml.v2";
- rev = "v2.2.4";
- sha256 = "11bwj757wi8kdrcnlgfqb8vv2d2xdhlghmyagd19i62khrkchsg2";
- };
- }
-]
From 65fd0312778cc86f0db9c4c87edcd5b06aacee7f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20G=C3=BCntner?= <code@mguentner.de>
Date: Sun, 13 Dec 2020 18:26:13 +0100
Subject: [PATCH 2/2] nixos: add prometheus_nginxlog_exporter module + test
---
.../monitoring/prometheus/exporters.nix | 1 +
.../prometheus/exporters/nginxlog.nix | 51 ++++++++++++++++
nixos/tests/prometheus-exporters.nix | 61 +++++++++++++++++++
.../prometheus/nginxlog-exporter.nix | 4 +-
4 files changed, 116 insertions(+), 1 deletion(-)
create mode 100644 nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
diff --git a/nixos/modules/services/monitoring/prometheus/exporters.nix b/nixos/modules/services/monitoring/prometheus/exporters.nix
index 1f8c5aeded1f..683dc0390c59 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters.nix
@@ -37,6 +37,7 @@ let
"modemmanager"
"nextcloud"
"nginx"
+ "nginxlog"
"node"
"openvpn"
"postfix"
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
new file mode 100644
index 000000000000..8c1f552d58a7
--- /dev/null
+++ b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix
@@ -0,0 +1,51 @@
+{ config, lib, pkgs, options }:
+
+with lib;
+
+let
+ cfg = config.services.prometheus.exporters.nginxlog;
+in {
+ port = 9117;
+ extraOpts = {
+ settings = mkOption {
+ type = types.attrs;
+ default = {};
+ description = ''
+ All settings of nginxlog expressed as an Nix attrset.
+
+ Check the official documentation for the corresponding YAML
+ settings that can all be used here: https://github.com/martin-helmich/prometheus-nginxlog-exporter
+
+ The `listen` object is already generated by `port`, `listenAddress` and `metricsEndpoint` and
+ will be merged with the value of `settings` before writting it as JSON.
+ '';
+ };
+
+ metricsEndpoint = mkOption {
+ type = types.str;
+ default = "/metrics";
+ description = ''
+ Path under which to expose metrics.
+ '';
+ };
+ };
+
+ serviceOpts = let
+ listenConfig = {
+ listen = {
+ port = cfg.port;
+ address = cfg.listenAddress;
+ metrics_endpoint = cfg.metricsEndpoint;
+ };
+ };
+ completeConfig = pkgs.writeText "nginxlog-exporter.yaml" (builtins.toJSON (lib.recursiveUpdate listenConfig cfg.settings));
+ in {
+ serviceConfig = {
+ ExecStart = ''
+ ${pkgs.prometheus-nginxlog-exporter}/bin/prometheus-nginxlog-exporter -config-file ${completeConfig}
+ '';
+ Restart="always";
+ ProtectSystem="full";
+ };
+ };
+}
diff --git a/nixos/tests/prometheus-exporters.nix b/nixos/tests/prometheus-exporters.nix
index 3eb4341e39cb..ffa7f420c093 100644
--- a/nixos/tests/prometheus-exporters.nix
+++ b/nixos/tests/prometheus-exporters.nix
@@ -444,6 +444,67 @@ let
'';
};
+ nginxlog = {
+ exporterConfig = {
+ enable = true;
+ group = "nginx";
+ settings = {
+ namespaces = [
+ {
+ name = "filelogger";
+ source = {
+ files = [ "/var/log/nginx/filelogger.access.log" ];
+ };
+ }
+ {
+ name = "syslogger";
+ source = {
+ syslog = {
+ listen_address = "udp://127.0.0.1:10000";
+ format = "rfc3164";
+ tags = ["nginx"];
+ };
+ };
+ }
+ ];
+ };
+ };
+ metricProvider = {
+ services.nginx = {
+ enable = true;
+ httpConfig = ''
+ server {
+ listen 80;
+ server_name filelogger.local;
+ access_log /var/log/nginx/filelogger.access.log;
+ }
+ server {
+ listen 81;
+ server_name syslogger.local;
+ access_log syslog:server=127.0.0.1:10000,tag=nginx,severity=info;
+ }
+ '';
+ };
+ };
+ exporterTest = ''
+ wait_for_unit("nginx.service")
+ wait_for_unit("prometheus-nginxlog-exporter.service")
+ wait_for_open_port(9117)
+ wait_for_open_port(80)
+ wait_for_open_port(81)
+ succeed("curl http://localhost")
+ execute("sleep 1")
+ succeed(
+ "curl -sSf http://localhost:9117/metrics | grep 'filelogger_http_response_count_total' | grep -q 1"
+ )
+ succeed("curl http://localhost:81")
+ execute("sleep 1")
+ succeed(
+ "curl -sSf http://localhost:9117/metrics | grep 'syslogger_http_response_count_total' | grep -q 1"
+ )
+ '';
+ };
+
node = {
exporterConfig = {
enable = true;
diff --git a/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix b/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
index a9276e0c924a..771bbf39b081 100644
--- a/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
+++ b/pkgs/servers/monitoring/prometheus/nginxlog-exporter.nix
@@ -1,4 +1,4 @@
-{ stdenv, buildGoModule, fetchFromGitHub }:
+{ stdenv, buildGoModule, fetchFromGitHub, nixosTests }:
buildGoModule rec {
pname = "nginxlog_exporter";
@@ -17,6 +17,8 @@ buildGoModule rec {
runVend = true;
+ passthru.tests = { inherit (nixosTests.prometheus-exporters) nginxlog; };
+
meta = with stdenv.lib; {
description = "Export metrics from Nginx access log files to Prometheus";
homepage = "https://github.com/martin-helmich/prometheus-nginxlog-exporter";