commit 1a821e7bf5254d84679273dd2f2e8f74f958d871 · pyrox.dev/nixpkgs

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

+65

nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix

···

       1
       +
       { config

     

       2
       +
       , lib

     

       3
       +
       , pkgs

     

       4
       +
       , options

     

       5
       +
       }:

     

       6
       +
       

     

       7
       +
       let

     

       8
       +
         logPrefix = "services.prometheus.exporter.php-fpm";

     

       9
       +
         cfg = config.services.prometheus.exporters.php-fpm;

     

       10
       +
       in {

     

       11
       +
         port = 9253;

     

       12
       +
         extraOpts = {

     

       13
       +
           package = lib.mkPackageOptionMD pkgs "prometheus-php-fpm-exporter" {};

     

       14
       +
       

     

       15
       +
           telemetryPath = lib.mkOption {

     

       16
       +
             type = lib.types.str;

     

       17
       +
             default = "/metrics";

     

       18
       +
             description = lib.mdDoc ''

     

       19
       +
               Path under which to expose metrics.

     

       20
       +
             '';

     

       21
       +
           };

     

       22
       +
       

     

       23
       +
           environmentFile = lib.mkOption {

     

       24
       +
             type = lib.types.nullOr lib.types.path;

     

       25
       +
             default = null;

     

       26
       +
             example = "/root/prometheus-php-fpm-exporter.env";

     

       27
       +
             description = lib.mdDoc ''

     

       28
       +
               Environment file as defined in {manpage}`systemd.exec(5)`.

     

       29
       +
       

     

       30
       +
               Secrets may be passed to the service without adding them to the

     

       31
       +
               world-readable Nix store, by specifying placeholder variables as

     

       32
       +
               the option value in Nix and setting these variables accordingly in the

     

       33
       +
               environment file.

     

       34
       +
       

     

       35
       +
               Environment variables from this file will be interpolated into the

     

       36
       +
               config file using envsubst with this syntax:

     

       37
       +
               `$ENVIRONMENT ''${VARIABLE}`

     

       38
       +
       

     

       39
       +
               For variables to use see [options and defaults](https://github.com/hipages/php-fpm_exporter#options-and-defaults).

     

       40
       +
       

     

       41
       +
               The main use is to set the PHP_FPM_SCRAPE_URI that indicate how to connect to PHP-FPM process.

     

       42
       +
       

     

       43
       +
               ```

     

       44
       +
                 # Content of the environment file

     

       45
       +
                 PHP_FPM_SCRAPE_URI="unix:///tmp/php.sock;/status"

     

       46
       +
               ```

     

       47
       +
       

     

       48
       +
               Note that this file needs to be available on the host on which

     

       49
       +
               this exporter is running.

     

       50
       +
             '';

     

       51
       +
           };

     

       52
       +
         };

     

       53
       +
       

     

       54
       +
         serviceOpts = {

     

       55
       +
           serviceConfig = {

     

       56
       +
             EnvironmentFile = lib.mkIf (cfg.environmentFile != null) [ cfg.environmentFile ];

     

       57
       +
             ExecStart = ''

     

       58
       +
               ${lib.getExe cfg.package} server \

     

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

     

       60
       +
                 --web.telemetry-path ${cfg.telemetryPath} \

     

       61
       +
                 ${lib.concatStringsSep " \\\n  " cfg.extraFlags}

     

       62
       +
             '';

     

       63
       +
           };

     

       64
       +
         };

     

       65
       +
       }

+42 -1

nixos/tests/prometheus-exporters.nix

···

       6
        
       let

     

       7
        
         inherit (import ../lib/testing-python.nix { inherit system pkgs; }) makeTest;

     

       8
        
         inherit (pkgs.lib) concatStringsSep maintainers mapAttrs mkMerge

     

       9
       -
           removeSuffix replaceStrings singleton splitString;

     

       10
        
       

     

       11
        
         /*

     

       12
        
           * The attrset `exporterTests` contains one attribute

     
···

       911
        
               wait_for_unit("openvpn-test.service")

     

       912
        
               wait_for_unit("prometheus-openvpn-exporter.service")

     

       913
        
               succeed("curl -sSf http://localhost:9176/metrics | grep 'openvpn_up{.*} 1'")

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       914
        
             '';

     

       915
        
           };

     

       916

···

       6
        
       let

     

       7
        
         inherit (import ../lib/testing-python.nix { inherit system pkgs; }) makeTest;

     

       8
        
         inherit (pkgs.lib) concatStringsSep maintainers mapAttrs mkMerge

     

       9
       +
           removeSuffix replaceStrings singleton splitString makeBinPath;

     

       10
        
       

     

       11
        
         /*

     

       12
        
           * The attrset `exporterTests` contains one attribute

     
···

       911
        
               wait_for_unit("openvpn-test.service")

     

       912
        
               wait_for_unit("prometheus-openvpn-exporter.service")

     

       913
        
               succeed("curl -sSf http://localhost:9176/metrics | grep 'openvpn_up{.*} 1'")

     

       914
       +
             '';

     

       915
       +
           };

     

       916
       +
       

     

       917
       +
           php-fpm = {

     

       918
       +
             nodeName = "php_fpm";

     

       919
       +
             exporterConfig = {

     

       920
       +
               enable = true;

     

       921
       +
               environmentFile = pkgs.writeTextFile {

     

       922
       +
                 name = "/tmp/prometheus-php-fpm-exporter.env";

     

       923
       +
                 text = ''

     

       924
       +
                   PHP_FPM_SCRAPE_URI="tcp://127.0.0.1:9000/status"

     

       925
       +
                 '';

     

       926
       +
               };

     

       927
       +
             };

     

       928
       +
             metricProvider = {

     

       929
       +
               users.users."php-fpm-exporter" = {

     

       930
       +
                 isSystemUser = true;

     

       931
       +
                 group  = "php-fpm-exporter";

     

       932
       +
               };

     

       933
       +
               users.groups."php-fpm-exporter" = {};

     

       934
       +
               services.phpfpm.pools."php-fpm-exporter" = {

     

       935
       +
                 user = "php-fpm-exporter";

     

       936
       +
                 group = "php-fpm-exporter";

     

       937
       +
                 settings = {

     

       938
       +
                   "pm" = "dynamic";

     

       939
       +
                   "pm.max_children" = 32;

     

       940
       +
                   "pm.max_requests" = 500;

     

       941
       +
                   "pm.start_servers" = 2;

     

       942
       +
                   "pm.min_spare_servers" = 2;

     

       943
       +
                   "pm.max_spare_servers" = 5;

     

       944
       +
                   "pm.status_path" = "/status";

     

       945
       +
                   "listen" = "127.0.0.1:9000";

     

       946
       +
                   "listen.allowed_clients" = "127.0.0.1";

     

       947
       +
                 };

     

       948
       +
                 phpEnv."PATH" = makeBinPath [ pkgs.php ];

     

       949
       +
               };

     

       950
       +
             };

     

       951
       +
             exporterTest = ''

     

       952
       +
               wait_for_unit("phpfpm-php-fpm-exporter.service")

     

       953
       +
               wait_for_unit("prometheus-php-fpm-exporter.service")

     

       954
       +
               succeed("curl -sSf http://localhost:9253/metrics | grep 'phpfpm_up{.*} 1'")

     

       955
        
             '';

     

       956
        
           };

     

       957