about summary refs log tree commit diff
path: root/nixpkgs/nixos/modules/services/monitoring/prometheus/exporters/php-fpm.nix
blob: 8238f1ac1856eccd37d674039a5924526bd82613 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{ config
, lib
, pkgs
, options
}:

let
  logPrefix = "services.prometheus.exporter.php-fpm";
  cfg = config.services.prometheus.exporters.php-fpm;
in {
  port = 9253;
  extraOpts = {
    package = lib.mkPackageOption pkgs "prometheus-php-fpm-exporter" {};

    telemetryPath = lib.mkOption {
      type = lib.types.str;
      default = "/metrics";
      description = lib.mdDoc ''
        Path under which to expose metrics.
      '';
    };

    environmentFile = lib.mkOption {
      type = lib.types.nullOr lib.types.path;
      default = null;
      example = "/root/prometheus-php-fpm-exporter.env";
      description = lib.mdDoc ''
        Environment file as defined in {manpage}`systemd.exec(5)`.

        Secrets may be passed to the service without adding them to the
        world-readable Nix store, by specifying placeholder variables as
        the option value in Nix and setting these variables accordingly in the
        environment file.

        Environment variables from this file will be interpolated into the
        config file using envsubst with this syntax:
        `$ENVIRONMENT ''${VARIABLE}`

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

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

        ```
          # Content of the environment file
          PHP_FPM_SCRAPE_URI="unix:///tmp/php.sock;/status"
        ```

        Note that this file needs to be available on the host on which
        this exporter is running.
      '';
    };
  };

  serviceOpts = {
    serviceConfig = {
      EnvironmentFile = lib.mkIf (cfg.environmentFile != null) [ cfg.environmentFile ];
      ExecStart = ''
        ${lib.getExe cfg.package} server \
          --web.listen-address ${cfg.listenAddress}:${toString cfg.port} \
          --web.telemetry-path ${cfg.telemetryPath} \
          ${lib.concatStringsSep " \\\n  " cfg.extraFlags}
      '';
    };
  };
}