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

   1 { config
   2 , lib
   3 , pkgs
   4 , options
   5 , ...
   6 }:
   7
   8 let
   9   logPrefix = "services.prometheus.exporter.php-fpm";
  10   cfg = config.services.prometheus.exporters.php-fpm;
  11 in {
  12   port = 9253;
  13   extraOpts = {
  14     package = lib.mkPackageOption pkgs "prometheus-php-fpm-exporter" {};
  15
  16     telemetryPath = lib.mkOption {
  17       type = lib.types.str;
  18       default = "/metrics";
  19       description = ''
  20         Path under which to expose metrics.
  21       '';
  22     };
  23
  24     environmentFile = lib.mkOption {
  25       type = lib.types.nullOr lib.types.path;
  26       default = null;
  27       example = "/root/prometheus-php-fpm-exporter.env";
  28       description = ''
  29         Environment file as defined in {manpage}`systemd.exec(5)`.
  30
  31         Secrets may be passed to the service without adding them to the
  32         world-readable Nix store, by specifying placeholder variables as
  33         the option value in Nix and setting these variables accordingly in the
  34         environment file.
  35
  36         Environment variables from this file will be interpolated into the
  37         config file using envsubst with this syntax:
  38         `$ENVIRONMENT ''${VARIABLE}`
  39
  40         For variables to use see [options and defaults](https://github.com/hipages/php-fpm_exporter#options-and-defaults).
  41
  42         The main use is to set the PHP_FPM_SCRAPE_URI that indicate how to connect to PHP-FPM process.
  43
  44         ```
  45           # Content of the environment file
  46           PHP_FPM_SCRAPE_URI="unix:///tmp/php.sock;/status"
  47         ```
  48
  49         Note that this file needs to be available on the host on which
  50         this exporter is running.
  51       '';
  52     };
  53   };
  54
  55   serviceOpts = {
  56     serviceConfig = {
  57       EnvironmentFile = lib.mkIf (cfg.environmentFile != null) [ cfg.environmentFile ];
  58       ExecStart = ''
  59         ${lib.getExe cfg.package} server \
  60           --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \
  61           --web.telemetry-path ${cfg.telemetryPath} \
  62           ${lib.concatStringsSep " \\\n  " cfg.extraFlags}
  63       '';
  64     };
  65   };
  66 }