summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/prometheus/minio-exporter.nix
blob: 4b6c96d96737c27692e4ae222d828646cbe560f2 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
{ config, pkgs, lib, ... }:

with lib;

let
  cfg = config.services.prometheus.minioExporter;
in {
  options = {
    services.prometheus.minioExporter = {
      enable = mkEnableOption "prometheus minio exporter";

      port = mkOption {
        type = types.int;
        default = 9290;
        description = ''
          Port to listen on.
        '';
      };

      listenAddress = mkOption {
        type = types.nullOr types.str;
        default = null;
        example = "0.0.0.0";
        description = ''
          Address to listen on for web interface and telemetry.
        '';
      };

      minioAddress = mkOption {
        type = types.str;
        example = "https://10.0.0.1:9000";
        description = ''
          The URL of the minio server.
          Use HTTPS if Minio accepts secure connections only.
        '';
      };

      minioAccessKey = mkOption {
        type = types.str;
        example = "BKIKJAA5BMMU2RHO6IBB";
        description = ''
          The value of the Minio access key.
          It is required in order to connect to the server.
        '';
      };

      minioAccessSecret = mkOption {
        type = types.str;
        description = ''
          The calue of the Minio access secret.
          It is required in order to connect to the server.
        '';
      };

      minioBucketStats = mkOption {
        type = types.bool;
        default = false;
        description = ''
          Collect statistics about the buckets and files in buckets.
          It requires more computation, use it carefully in case of large buckets..
        '';
      };

      extraFlags = mkOption {
        type = types.listOf types.str;
        default = [];
        description = ''
          Extra commandline options when launching the minio exporter.
        '';
      };

      openFirewall = mkOption {
        type = types.bool;
        default = false;
        description = ''
          Open port in firewall for incoming connections.
        '';
      };
    };
  };

  config = mkIf cfg.enable {
    networking.firewall.allowedTCPPorts = optional cfg.openFirewall cfg.port;

    systemd.services.prometheus-minio-exporter = {
      description = "Prometheus exporter for Minio server metrics";
      unitConfig.Documentation = "https://github.com/joe-pll/minio-exporter";
      wantedBy = [ "multi-user.target" ];
      after = optional config.services.minio.enable "minio.service";
      serviceConfig = {
        DynamicUser = true;
        Restart = "always";
        PrivateTmp = true;
        WorkingDirectory = /tmp;
        ExecStart = ''
          ${pkgs.prometheus-minio-exporter}/bin/minio-exporter \
            -web.listen-address ${optionalString (cfg.listenAddress != null) cfg.listenAddress}:${toString cfg.port} \
            -minio.server ${cfg.minioAddress} \
            -minio.access-key ${cfg.minioAccessKey} \
            -minio.access-secret ${cfg.minioAccessSecret} \
            ${optionalString cfg.minioBucketStats "-minio.bucket-stats"} \
            ${concatStringsSep " \\\n  " cfg.extraFlags}
        '';
      };
    };
  };
}