commit 68726901e155c10c92941c58aee522a8a385d69a · pyrox.dev/nixpkgs

nixos/modules/services/monitoring/prometheus/exporters.nix

···

       45
       45
        
           "rspamd"

     

       46
       46
        
           "rtl_433"

     

       47
       47
        
           "snmp"

     

       48
       48
       +
           "sql"

     

       48
       49
        
           "surfboard"

     

       49
       50
        
           "tor"

     

       50
       51
        
           "unifi"

     
···

       217
       218
        
             message = ''

     

       218
       219
        
               Please specify either 'services.prometheus.exporters.mail.configuration'

     

       219
       220
        
                 or 'services.prometheus.exporters.mail.configFile'.

     

       221
       221
       +
             '';

     

       222
       222
       +
           } {

     

       223
       223
       +
             assertion = cfg.sql.enable -> (

     

       224
       224
       +
               (cfg.sql.configFile == null) != (cfg.sql.configuration == null)

     

       225
       225
       +
             );

     

       226
       226
       +
             message = ''

     

       227
       227
       +
               Please specify either 'services.prometheus.exporters.sql.configuration' or

     

       228
       228
       +
                 'services.prometheus.exporters.sql.configFile'

     

       220
       229
        
             '';

     

       221
       230
        
           } ];

     

       222
       231
        
         }] ++ [(mkIf config.services.minio.enable {

+104

nixos/modules/services/monitoring/prometheus/exporters/sql.nix

···

       1
       1
       +
       { config, lib, pkgs, options }:

     

       2
       2
       +
       with lib;

     

       3
       3
       +
       let

     

       4
       4
       +
         cfg = config.services.prometheus.exporters.sql;

     

       5
       5
       +
         cfgOptions = {

     

       6
       6
       +
           options = with types; {

     

       7
       7
       +
             jobs = mkOption {

     

       8
       8
       +
               type = attrsOf (submodule jobOptions);

     

       9
       9
       +
               default = { };

     

       10
       10
       +
               description = "An attrset of metrics scraping jobs to run.";

     

       11
       11
       +
             };

     

       12
       12
       +
           };

     

       13
       13
       +
         };

     

       14
       14
       +
         jobOptions = {

     

       15
       15
       +
           options = with types; {

     

       16
       16
       +
             interval = mkOption {

     

       17
       17
       +
               type = str;

     

       18
       18
       +
               description = ''

     

       19
       19
       +
                 How often to run this job, specified in

     

       20
       20
       +
                 <link xlink:href="https://golang.org/pkg/time/#ParseDuration">Go duration</link> format.

     

       21
       21
       +
               '';

     

       22
       22
       +
             };

     

       23
       23
       +
             connections = mkOption {

     

       24
       24
       +
               type = listOf str;

     

       25
       25
       +
               description = "A list of connection strings of the SQL servers to scrape metrics from";

     

       26
       26
       +
             };

     

       27
       27
       +
             startupSql = mkOption {

     

       28
       28
       +
               type = listOf str;

     

       29
       29
       +
               default = [];

     

       30
       30
       +
               description = "A list of SQL statements to execute once after making a connection.";

     

       31
       31
       +
             };

     

       32
       32
       +
             queries = mkOption {

     

       33
       33
       +
               type = attrsOf (submodule queryOptions);

     

       34
       34
       +
               description = "SQL queries to run.";

     

       35
       35
       +
             };

     

       36
       36
       +
           };

     

       37
       37
       +
         };

     

       38
       38
       +
         queryOptions = {

     

       39
       39
       +
           options = with types; {

     

       40
       40
       +
             help = mkOption {

     

       41
       41
       +
               type = nullOr str;

     

       42
       42
       +
               default = null;

     

       43
       43
       +
               description = "A human-readable description of this metric.";

     

       44
       44
       +
             };

     

       45
       45
       +
             labels = mkOption {

     

       46
       46
       +
               type = listOf str;

     

       47
       47
       +
               default = [ ];

     

       48
       48
       +
               description = "A set of columns that will be used as Prometheus labels.";

     

       49
       49
       +
             };

     

       50
       50
       +
             query = mkOption {

     

       51
       51
       +
               type = str;

     

       52
       52
       +
               description = "The SQL query to run.";

     

       53
       53
       +
             };

     

       54
       54
       +
             values = mkOption {

     

       55
       55
       +
               type = listOf str;

     

       56
       56
       +
               description = "A set of columns that will be used as values of this metric.";

     

       57
       57
       +
             };

     

       58
       58
       +
           };

     

       59
       59
       +
         };

     

       60
       60
       +
       

     

       61
       61
       +
         configFile =

     

       62
       62
       +
           if cfg.configFile != null

     

       63
       63
       +
           then cfg.configFile

     

       64
       64
       +
           else

     

       65
       65
       +
             let

     

       66
       66
       +
               nameInline = mapAttrsToList (k: v: v // { name = k; });

     

       67
       67
       +
               renameStartupSql = j: removeAttrs (j // { startup_sql = j.startupSql; }) [ "startupSql" ];

     

       68
       68
       +
               configuration = {

     

       69
       69
       +
                 jobs = map renameStartupSql

     

       70
       70
       +
                   (nameInline (mapAttrs (k: v: (v // { queries = nameInline v.queries; })) cfg.configuration.jobs));

     

       71
       71
       +
               };

     

       72
       72
       +
             in

     

       73
       73
       +
             builtins.toFile "config.yaml" (builtins.toJSON configuration);

     

       74
       74
       +
       in

     

       75
       75
       +
       {

     

       76
       76
       +
         extraOpts = {

     

       77
       77
       +
           configFile = mkOption {

     

       78
       78
       +
             type = with types; nullOr path;

     

       79
       79
       +
             default = null;

     

       80
       80
       +
             description = ''

     

       81
       81
       +
               Path to configuration file.

     

       82
       82
       +
             '';

     

       83
       83
       +
           };

     

       84
       84
       +
           configuration = mkOption {

     

       85
       85
       +
             type = with types; nullOr (submodule cfgOptions);

     

       86
       86
       +
             default = null;

     

       87
       87
       +
             description = ''

     

       88
       88
       +
               Exporter configuration as nix attribute set. Mutually exclusive with 'configFile' option.

     

       89
       89
       +
             '';

     

       90
       90
       +
           };

     

       91
       91
       +
         };

     

       92
       92
       +
       

     

       93
       93
       +
         port = 9237;

     

       94
       94
       +
         serviceOpts = {

     

       95
       95
       +
           serviceConfig = {

     

       96
       96
       +
             ExecStart = ''

     

       97
       97
       +
               ${pkgs.prometheus-sql-exporter}/bin/sql_exporter \

     

       98
       98
       +
                 -web.listen-address ${cfg.listenAddress}:${toString cfg.port} \

     

       99
       99
       +
                 -config.file ${configFile} \

     

       100
       100
       +
                 ${concatStringsSep " \\\n  " cfg.extraFlags}

     

       101
       101
       +
             '';

     

       102
       102
       +
           };

     

       103
       103
       +
         };

     

       104
       104
       +
       }

+44

nixos/tests/prometheus-exporters.nix

···

       609
       609
        
             '';

     

       610
       610
        
           };

     

       611
       611
        
       

     

       612
       612
       +
           sql = {

     

       613
       613
       +
             exporterConfig = {

     

       614
       614
       +
               configuration.jobs.points = {

     

       615
       615
       +
                 interval = "1m";

     

       616
       616
       +
                 connections = [

     

       617
       617
       +
                   "postgres://prometheus-sql-exporter@/data?host=/run/postgresql&sslmode=disable"

     

       618
       618
       +
                 ];

     

       619
       619
       +
                 queries = {

     

       620
       620
       +
                   points = {

     

       621
       621
       +
                     labels = [ "name" ];

     

       622
       622
       +
                     help = "Amount of points accumulated per person";

     

       623
       623
       +
                     values = [ "amount" ];

     

       624
       624
       +
                     query = "SELECT SUM(amount) as amount, name FROM points GROUP BY name";

     

       625
       625
       +
                   };

     

       626
       626
       +
                 };

     

       627
       627
       +
               };

     

       628
       628
       +
               enable = true;

     

       629
       629
       +
               user = "prometheus-sql-exporter";

     

       630
       630
       +
             };

     

       631
       631
       +
             metricProvider = {

     

       632
       632
       +
               services.postgresql = {

     

       633
       633
       +
                 enable = true;

     

       634
       634
       +
                 initialScript = builtins.toFile "init.sql" ''

     

       635
       635
       +
                   CREATE DATABASE data;

     

       636
       636
       +
                   \c data;

     

       637
       637
       +
                   CREATE TABLE points (amount INT, name TEXT);

     

       638
       638
       +
                   INSERT INTO points(amount, name) VALUES (1, 'jack');

     

       639
       639
       +
                   INSERT INTO points(amount, name) VALUES (2, 'jill');

     

       640
       640
       +
                   INSERT INTO points(amount, name) VALUES (3, 'jack');

     

       641
       641
       +
       

     

       642
       642
       +
                   CREATE USER "prometheus-sql-exporter";

     

       643
       643
       +
                   GRANT ALL PRIVILEGES ON DATABASE data TO "prometheus-sql-exporter";

     

       644
       644
       +
                   GRANT SELECT ON points TO "prometheus-sql-exporter";

     

       645
       645
       +
                 '';

     

       646
       646
       +
               };

     

       647
       647
       +
               systemd.services.prometheus-sql-exporter.after = [ "postgresql.service" ];

     

       648
       648
       +
             };

     

       649
       649
       +
             exporterTest = ''

     

       650
       650
       +
               wait_for_unit("prometheus-sql-exporter.service")

     

       651
       651
       +
               wait_for_open_port(9237)

     

       652
       652
       +
               succeed("curl http://localhost:9237/metrics | grep -c 'sql_points{' | grep -q 2")

     

       653
       653
       +
             '';

     

       654
       654
       +
           };

     

       655
       655
       +
       

     

       612
       656
        
           surfboard = {

     

       613
       657
        
             exporterConfig = {

     

       614
       658
        
               enable = true;

+23

pkgs/servers/monitoring/prometheus/sql-exporter.nix

···

       1
       1
       +
       { stdenv, buildGoModule, fetchFromGitHub, nixosTests }:

     

       2
       2
       +
       

     

       3
       3
       +
       buildGoModule rec {

     

       4
       4
       +
         pname = "sql_exporter";

     

       5
       5
       +
         version = "0.3.0";

     

       6
       6
       +
       

     

       7
       7
       +
         vendorSha256 = null;

     

       8
       8
       +
       

     

       9
       9
       +
         src = fetchFromGitHub {

     

       10
       10
       +
           owner = "justwatchcom";

     

       11
       11
       +
           repo = "sql_exporter";

     

       12
       12
       +
           rev = "v${version}";

     

       13
       13
       +
           sha256 = "125brlxgwhkn3z5v0522gpm0sk6v905ghh05c4c3wf1hlm7bhnrc";

     

       14
       14
       +
         };

     

       15
       15
       +
       

     

       16
       16
       +
         meta = with stdenv.lib; {

     

       17
       17
       +
           description = "Flexible SQL exporter for Prometheus";

     

       18
       18
       +
           homepage = "https://github.com/justwatchcom/sql_exporter";

     

       19
       19
       +
           license = licenses.mit;

     

       20
       20
       +
           maintainers = with maintainers; [ justinas ];

     

       21
       21
       +
           platforms = platforms.unix;

     

       22
       22
       +
         };

     

       23
       23
       +
       }

pkgs/top-level/all-packages.nix

···

       17226
       17226
        
         prometheus-rabbitmq-exporter = callPackage ../servers/monitoring/prometheus/rabbitmq-exporter.nix { };

     

       17227
       17227
        
         prometheus-rtl_433-exporter = callPackage ../servers/monitoring/prometheus/rtl_433-exporter.nix { };

     

       17228
       17228
        
         prometheus-snmp-exporter = callPackage ../servers/monitoring/prometheus/snmp-exporter.nix { };

     

       17229
       17229
       +
         prometheus-sql-exporter = callPackage ../servers/monitoring/prometheus/sql-exporter.nix { };

     

       17229
       17230
        
         prometheus-tor-exporter = callPackage ../servers/monitoring/prometheus/tor-exporter.nix { };

     

       17230
       17231
        
         prometheus-statsd-exporter = callPackage ../servers/monitoring/prometheus/statsd-exporter.nix { };

     

       17231
       17232
        
         prometheus-surfboard-exporter = callPackage ../servers/monitoring/prometheus/surfboard-exporter.nix { };