about summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/prometheus/exporters/fritz.nix
blob: c3a962b576a5b0a14bb1d8689c6c9784e68275d6 (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
{ config, lib, pkgs, utils, ... }:
let
  inherit (lib) mkOption types mdDoc;
  cfg = config.services.prometheus.exporters.fritz;
  yaml = pkgs.formats.yaml { };
  configFile = yaml.generate "fritz-exporter.yaml" cfg.settings;
in
{
  port = 9787;

  extraOpts = {
    settings = mkOption {
      description = mdDoc "Configuration settings for fritz-exporter.";
      type = types.submodule {
        freeformType = yaml.type;

        options = {
          # Pull existing port option into config file.
          port = mkOption {
            type = types.port;
            default = cfg.port;
            internal = true;
            visible = false;
          };
          # Pull existing listen address option into config file.
          listen_address = mkOption {
            type = types.str;
            default = cfg.listenAddress;
            internal = true;
            visible = false;
          };
          log_level = mkOption {
            type = types.enum [ "DEBUG" "INFO" "WARNING" "ERROR" "CRITICAL" ];
            default = "INFO";
            description = mdDoc ''
              Log level to use for the exporter.
            '';
          };
          devices = mkOption {
            default = [];
            description = "Fritz!-devices to monitor using the exporter.";
            type = with types; listOf (submodule {
              freeformType = yaml.type;

              options = {
                name = mkOption {
                  type = types.str;
                  default = "";
                  description = mdDoc ''
                    Name to use for the device.
                  '';
                };
                hostname = mkOption {
                  type = types.str;
                  default = "fritz.box";
                  description = mdDoc ''
                    Hostname under which the target device is reachable.
                  '';
                };
                username = mkOption {
                  type = types.str;
                  description = mdDoc ''
                    Username to authenticate with the target device.
                  '';
                };
                password_file = mkOption {
                  type = types.path;
                  description = mdDoc ''
                    Path to a file which contains the password to authenticate with the target device.
                    Needs to be readable by the user the exporter runs under.
                  '';
                };
                host_info = mkOption {
                  type = types.bool;
                  description = mdDoc ''
                    Enable extended host info for this device. *Warning*: This will heavily increase scrape time.
                  '';
                  default = false;
                };
              };
            });
          };
        };
      };
    };
  };

  serviceOpts = {
    serviceConfig = {
      ExecStart = utils.escapeSystemdExecArgs ([
        (lib.getExe pkgs.fritz-exporter)
        "--config" configFile
      ] ++ cfg.extraFlags);
      DynamicUser = false;
    };
  };
}