commit d1940beb3a0547d5892f0e063a515a3923a92be5 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       491
       491
        
         ./services/monitoring/prometheus/default.nix

     

       492
       492
        
         ./services/monitoring/prometheus/alertmanager.nix

     

       493
       493
        
         ./services/monitoring/prometheus/exporters.nix

     

       494
       494
       +
         ./services/monitoring/prometheus/pushgateway.nix

     

       494
       495
        
         ./services/monitoring/riemann.nix

     

       495
       496
        
         ./services/monitoring/riemann-dash.nix

     

       496
       497
        
         ./services/monitoring/riemann-tools.nix

+166

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

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.prometheus.pushgateway;

     

       7
       7
       +
       

     

       8
       8
       +
         cmdlineArgs =

     

       9
       9
       +
              opt "web.listen-address" cfg.web.listen-address

     

       10
       10
       +
           ++ opt "web.telemetry-path" cfg.web.telemetry-path

     

       11
       11
       +
           ++ opt "web.external-url" cfg.web.external-url

     

       12
       12
       +
           ++ opt "web.route-prefix" cfg.web.route-prefix

     

       13
       13
       +
           ++ optional cfg.persistMetrics ''--persistence.file="/var/lib/${cfg.stateDir}/metrics"''

     

       14
       14
       +
           ++ opt "persistence.interval" cfg.persistence.interval

     

       15
       15
       +
           ++ opt "log.level" cfg.log.level

     

       16
       16
       +
           ++ opt "log.format" cfg.log.format

     

       17
       17
       +
           ++ cfg.extraFlags;

     

       18
       18
       +
       

     

       19
       19
       +
         opt = k : v : optional (v != null) ''--${k}="${v}"'';

     

       20
       20
       +
       

     

       21
       21
       +
       in {

     

       22
       22
       +
         options = {

     

       23
       23
       +
           services.prometheus.pushgateway = {

     

       24
       24
       +
             enable = mkEnableOption "Prometheus Pushgateway";

     

       25
       25
       +
       

     

       26
       26
       +
             package = mkOption {

     

       27
       27
       +
               type = types.package;

     

       28
       28
       +
               default = pkgs.prometheus-pushgateway;

     

       29
       29
       +
               defaultText = "pkgs.prometheus-pushgateway";

     

       30
       30
       +
               description = ''

     

       31
       31
       +
                 Package that should be used for the prometheus pushgateway.

     

       32
       32
       +
               '';

     

       33
       33
       +
             };

     

       34
       34
       +
       

     

       35
       35
       +
             web.listen-address = mkOption {

     

       36
       36
       +
               type = types.nullOr types.str;

     

       37
       37
       +
               default = null;

     

       38
       38
       +
               description = ''

     

       39
       39
       +
                 Address to listen on for the web interface, API and telemetry.

     

       40
       40
       +
       

     

       41
       41
       +
                 <literal>null</literal> will default to <literal>:9091</literal>.

     

       42
       42
       +
               '';

     

       43
       43
       +
             };

     

       44
       44
       +
       

     

       45
       45
       +
             web.telemetry-path = mkOption {

     

       46
       46
       +
               type = types.nullOr types.str;

     

       47
       47
       +
               default = null;

     

       48
       48
       +
               description = ''

     

       49
       49
       +
                 Path under which to expose metrics.

     

       50
       50
       +
       

     

       51
       51
       +
                 <literal>null</literal> will default to <literal>/metrics</literal>.

     

       52
       52
       +
               '';

     

       53
       53
       +
             };

     

       54
       54
       +
       

     

       55
       55
       +
             web.external-url = mkOption {

     

       56
       56
       +
               type = types.nullOr types.str;

     

       57
       57
       +
               default = null;

     

       58
       58
       +
               description = ''

     

       59
       59
       +
                 The URL under which Pushgateway is externally reachable.

     

       60
       60
       +
               '';

     

       61
       61
       +
             };

     

       62
       62
       +
       

     

       63
       63
       +
             web.route-prefix = mkOption {

     

       64
       64
       +
               type = types.nullOr types.str;

     

       65
       65
       +
               default = null;

     

       66
       66
       +
               description = ''

     

       67
       67
       +
                 Prefix for the internal routes of web endpoints.

     

       68
       68
       +
       

     

       69
       69
       +
                 Defaults to the path of

     

       70
       70
       +
                 <option>services.prometheus.pushgateway.web.external-url</option>.

     

       71
       71
       +
               '';

     

       72
       72
       +
             };

     

       73
       73
       +
       

     

       74
       74
       +
             persistence.interval = mkOption {

     

       75
       75
       +
               type = types.nullOr types.str;

     

       76
       76
       +
               default = null;

     

       77
       77
       +
               example = "10m";

     

       78
       78
       +
               description = ''

     

       79
       79
       +
                 The minimum interval at which to write out the persistence file.

     

       80
       80
       +
       

     

       81
       81
       +
                 <literal>null</literal> will default to <literal>5m</literal>.

     

       82
       82
       +
               '';

     

       83
       83
       +
             };

     

       84
       84
       +
       

     

       85
       85
       +
             log.level = mkOption {

     

       86
       86
       +
               type = types.nullOr (types.enum ["debug" "info" "warn" "error" "fatal"]);

     

       87
       87
       +
               default = null;

     

       88
       88
       +
               description = ''

     

       89
       89
       +
                 Only log messages with the given severity or above.

     

       90
       90
       +
       

     

       91
       91
       +
                 <literal>null</literal> will default to <literal>info</literal>.

     

       92
       92
       +
               '';

     

       93
       93
       +
             };

     

       94
       94
       +
       

     

       95
       95
       +
             log.format = mkOption {

     

       96
       96
       +
               type = types.nullOr types.str;

     

       97
       97
       +
               default = null;

     

       98
       98
       +
               example = "logger:syslog?appname=bob&local=7";

     

       99
       99
       +
               description = ''

     

       100
       100
       +
                 Set the log target and format.

     

       101
       101
       +
       

     

       102
       102
       +
                 <literal>null</literal> will default to <literal>logger:stderr</literal>.

     

       103
       103
       +
               '';

     

       104
       104
       +
             };

     

       105
       105
       +
       

     

       106
       106
       +
             extraFlags = mkOption {

     

       107
       107
       +
               type = types.listOf types.str;

     

       108
       108
       +
               default = [];

     

       109
       109
       +
               description = ''

     

       110
       110
       +
                 Extra commandline options when launching the Pushgateway.

     

       111
       111
       +
               '';

     

       112
       112
       +
             };

     

       113
       113
       +
       

     

       114
       114
       +
             persistMetrics = mkOption {

     

       115
       115
       +
               type = types.bool;

     

       116
       116
       +
               default = false;

     

       117
       117
       +
               description = ''

     

       118
       118
       +
                 Whether to persist metrics to a file.

     

       119
       119
       +
       

     

       120
       120
       +
                 When enabled metrics will be saved to a file called

     

       121
       121
       +
                 <literal>metrics</literal> in the directory

     

       122
       122
       +
                 <literal>/var/lib/pushgateway</literal>. The directory below

     

       123
       123
       +
                 <literal>/var/lib</literal> can be set using

     

       124
       124
       +
                 <option>services.prometheus.pushgateway.stateDir</option>.

     

       125
       125
       +
               '';

     

       126
       126
       +
             };

     

       127
       127
       +
       

     

       128
       128
       +
             stateDir = mkOption {

     

       129
       129
       +
               type = types.str;

     

       130
       130
       +
               default = "pushgateway";

     

       131
       131
       +
               description = ''

     

       132
       132
       +
                 Directory below <literal>/var/lib</literal> to store metrics.

     

       133
       133
       +
       

     

       134
       134
       +
                 This directory will be created automatically using systemd's

     

       135
       135
       +
                 StateDirectory mechanism when

     

       136
       136
       +
                 <option>services.prometheus.pushgateway.persistMetrics</option>

     

       137
       137
       +
                 is enabled.

     

       138
       138
       +
               '';

     

       139
       139
       +
             };

     

       140
       140
       +
           };

     

       141
       141
       +
         };

     

       142
       142
       +
       

     

       143
       143
       +
         config = mkIf cfg.enable {

     

       144
       144
       +
           assertions = [

     

       145
       145
       +
             {

     

       146
       146
       +
               assertion = !hasPrefix "/" cfg.stateDir;

     

       147
       147
       +
               message =

     

       148
       148
       +
                 "The option services.prometheus.pushgateway.stateDir" +

     

       149
       149
       +
                 " shouldn't be an absolute directory." +

     

       150
       150
       +
                 " It should be a directory relative to /var/lib.";

     

       151
       151
       +
             }

     

       152
       152
       +
           ];

     

       153
       153
       +
           systemd.services.pushgateway = {

     

       154
       154
       +
             wantedBy = [ "multi-user.target" ];

     

       155
       155
       +
             after    = [ "network.target" ];

     

       156
       156
       +
             serviceConfig = {

     

       157
       157
       +
               Restart  = "always";

     

       158
       158
       +
               DynamicUser = true;

     

       159
       159
       +
               ExecStart = "${cfg.package}/bin/pushgateway" +

     

       160
       160
       +
                 optionalString (length cmdlineArgs != 0) (" \\\n  " +

     

       161
       161
       +
                   concatStringsSep " \\\n  " cmdlineArgs);

     

       162
       162
       +
               StateDirectory = if cfg.persistMetrics then cfg.stateDir else null;

     

       163
       163
       +
             };

     

       164
       164
       +
           };

     

       165
       165
       +
         };

     

       166
       166
       +
       }

+40 -7

nixos/tests/prometheus-2.nix

···

       3
       3
        
       

     

       4
       4
        
         nodes = {

     

       5
       5
        
           one = { pkgs, ... }: {

     

       6
       6
       +
             environment.systemPackages = [ pkgs.jq ];

     

       6
       7
        
             services.prometheus2 = {

     

       7
       8
        
               enable = true;

     

       8
       8
       -
               scrapeConfigs = [{

     

       9
       9
       -
                 job_name = "prometheus";

     

       10
       10
       -
                 static_configs = [{

     

       11
       11
       -
                   targets = [ "127.0.0.1:9090" ];

     

       12
       12
       -
                   labels = { instance = "localhost"; };

     

       13
       13
       -
                 }];

     

       14
       14
       -
               }];

     

       9
       9
       +
               scrapeConfigs = [

     

       10
       10
       +
                 {

     

       11
       11
       +
                   job_name = "prometheus";

     

       12
       12
       +
                   static_configs = [

     

       13
       13
       +
                     {

     

       14
       14
       +
                       targets = [ "127.0.0.1:9090" ];

     

       15
       15
       +
                       labels = { instance = "localhost"; };

     

       16
       16
       +
                     }

     

       17
       17
       +
                   ];

     

       18
       18
       +
                 }

     

       19
       19
       +
                 {

     

       20
       20
       +
                   job_name = "pushgateway";

     

       21
       21
       +
                   scrape_interval = "1s";

     

       22
       22
       +
                   static_configs = [

     

       23
       23
       +
                     {

     

       24
       24
       +
                       targets = [ "127.0.0.1:9091" ];

     

       25
       25
       +
                     }

     

       26
       26
       +
                   ];

     

       27
       27
       +
                 }

     

       28
       28
       +
               ];

     

       15
       29
        
               rules = [

     

       16
       30
        
                 ''

     

       17
       31
        
                   groups:

     
···

       22
       36
        
                 ''

     

       23
       37
        
               ];

     

       24
       38
        
             };

     

       39
       39
       +
             services.prometheus.pushgateway = {

     

       40
       40
       +
               enable = true;

     

       41
       41
       +
               persistMetrics = true;

     

       42
       42
       +
               persistence.interval = "1s";

     

       43
       43
       +
               stateDir = "prometheus-pushgateway";

     

       44
       44
       +
             };

     

       25
       45
        
           };

     

       26
       46
        
         };

     

       27
       47
        
       

     
···

       30
       50
        
           $one->waitForUnit("prometheus2.service");

     

       31
       51
        
           $one->waitForOpenPort(9090);

     

       32
       52
        
           $one->succeed("curl -s http://127.0.0.1:9090/metrics");

     

       53
       53
       +
       

     

       54
       54
       +
           # Let's test if pushing a metric to the pushgateway succeeds

     

       55
       55
       +
           # and whether that metric gets ingested by prometheus.

     

       56
       56
       +
           $one->waitForUnit("pushgateway.service");

     

       57
       57
       +
           $one->succeed(

     

       58
       58
       +
             "echo 'some_metric 3.14' | " .

     

       59
       59
       +
             "curl --data-binary \@- http://127.0.0.1:9091/metrics/job/some_job");

     

       60
       60
       +
           $one->waitUntilSucceeds(

     

       61
       61
       +
             "curl -sf 'http://127.0.0.1:9090/api/v1/query?query=some_metric' " .

     

       62
       62
       +
             "| jq '.data.result[0].value[1]' | grep '\"3.14\"'");

     

       63
       63
       +
       

     

       64
       64
       +
           # Let's test if the pushgateway persists metrics to the configured location.

     

       65
       65
       +
           $one->waitUntilSucceeds("test -e /var/lib/prometheus-pushgateway/metrics");

     

       33
       66
        
         '';

     

       34
       67
        
       }