commit d423567a9506f6ccfc09b137e6184280b92e37b6 · pyrox.dev/nixpkgs

+127
nixos/modules/services/monitoring/prometheus/snmp-exporter.nix
···

       1
       1
       +
       { config, pkgs, lib, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.prometheus.snmpExporter;

     

       7
       7
       +
         mkConfigFile = pkgs.writeText "snmp.yml" (if cfg.configurationPath == null then builtins.toJSON cfg.configuration else builtins.readFile cfg.configurationPath);

     

       8
       8
       +
       in {

     

       9
       9
       +
         options = {

     

       10
       10
       +
           services.prometheus.snmpExporter = {

     

       11
       11
       +
             enable = mkEnableOption "Prometheus snmp exporter";

     

       12
       12
       +
       

     

       13
       13
       +
             user = mkOption {

     

       14
       14
       +
               type = types.str;

     

       15
       15
       +
               default = "nobody";

     

       16
       16
       +
               description = ''

     

       17
       17
       +
                 User name under which snmp exporter shall be run.

     

       18
       18
       +
               '';

     

       19
       19
       +
             };

     

       20
       20
       +
       

     

       21
       21
       +
             group = mkOption {

     

       22
       22
       +
               type = types.str;

     

       23
       23
       +
               default = "nogroup";

     

       24
       24
       +
               description = ''

     

       25
       25
       +
                 Group under which snmp exporter shall be run.

     

       26
       26
       +
               '';

     

       27
       27
       +
             };

     

       28
       28
       +
       

     

       29
       29
       +
             port = mkOption {

     

       30
       30
       +
               type = types.int;

     

       31
       31
       +
               default = 9116;

     

       32
       32
       +
               description = ''

     

       33
       33
       +
                 Port to listen on.

     

       34
       34
       +
               '';

     

       35
       35
       +
             };

     

       36
       36
       +
       

     

       37
       37
       +
             listenAddress = mkOption {

     

       38
       38
       +
               type = types.nullOr types.str;

     

       39
       39
       +
               default = null;

     

       40
       40
       +
               description = ''

     

       41
       41
       +
                 Address to listen on for web interface and telemetry.

     

       42
       42
       +
               '';

     

       43
       43
       +
             };

     

       44
       44
       +
       

     

       45
       45
       +
             configurationPath = mkOption {

     

       46
       46
       +
               type = types.nullOr types.path;

     

       47
       47
       +
               default = null;

     

       48
       48
       +
               description = ''

     

       49
       49
       +
                 Path to a snmp exporter configuration file. Mutually exclusive with 'configuration' option.

     

       50
       50
       +
               '';

     

       51
       51
       +
               example = "./snmp.yml";

     

       52
       52
       +
             };

     

       53
       53
       +
       

     

       54
       54
       +
             configuration = mkOption {

     

       55
       55
       +
               type = types.nullOr types.attrs;

     

       56
       56
       +
               default = {};

     

       57
       57
       +
               description = ''

     

       58
       58
       +
                 Snmp exporter configuration as nix attribute set. Mutually exclusive with 'configurationPath' option.

     

       59
       59
       +
               '';

     

       60
       60
       +
               example = ''

     

       61
       61
       +
                 {

     

       62
       62
       +
                   "default" = {

     

       63
       63
       +
                     "version" = 2;

     

       64
       64
       +
                     "auth" = {

     

       65
       65
       +
                       "community" = "public";

     

       66
       66
       +
                     };

     

       67
       67
       +
                   };

     

       68
       68
       +
                 };

     

       69
       69
       +
               '';

     

       70
       70
       +
             };

     

       71
       71
       +
       

     

       72
       72
       +
             logFormat = mkOption {

     

       73
       73
       +
               type = types.str;

     

       74
       74
       +
               default = "logger:stderr";

     

       75
       75
       +
               description = ''

     

       76
       76
       +
                 Set the log target and format.

     

       77
       77
       +
               '';

     

       78
       78
       +
             };

     

       79
       79
       +
       

     

       80
       80
       +
             logLevel = mkOption {

     

       81
       81
       +
               type = types.enum ["debug" "info" "warn" "error" "fatal"];

     

       82
       82
       +
               default = "info";

     

       83
       83
       +
               description = ''

     

       84
       84
       +
                 Only log messages with the given severity or above.

     

       85
       85
       +
               '';

     

       86
       86
       +
             };

     

       87
       87
       +
       

     

       88
       88
       +
             openFirewall = mkOption {

     

       89
       89
       +
               type = types.bool;

     

       90
       90
       +
               default = false;

     

       91
       91
       +
               description = ''

     

       92
       92
       +
                 Open port in firewall for incoming connections.

     

       93
       93
       +
               '';

     

       94
       94
       +
             };

     

       95
       95
       +
           };

     

       96
       96
       +
         };

     

       97
       97
       +
       

     

       98
       98
       +
         config = mkIf cfg.enable {

     

       99
       99
       +
           networking.firewall.allowedTCPPorts = optional cfg.openFirewall cfg.port;

     

       100
       100
       +
       

     

       101
       101
       +
           assertions = singleton

     

       102
       102
       +
             {

     

       103
       103
       +
               assertion = (cfg.configurationPath == null) != (cfg.configuration == null);

     

       104
       104
       +
               message = "Please ensure you have either 'configuration' or 'configurationPath' set!";

     

       105
       105
       +
             };

     

       106
       106
       +
       

     

       107
       107
       +
           systemd.services.prometheus-snmp-exporter = {

     

       108
       108
       +
             wantedBy = [ "multi-user.target" ];

     

       109
       109
       +
             after = [ "network.target" ];

     

       110
       110
       +
             script = ''

     

       111
       111
       +
               ${pkgs.prometheus-snmp-exporter.bin}/bin/snmp_exporter \

     

       112
       112
       +
                 -config.file ${mkConfigFile} \

     

       113
       113
       +
                 -log.format ${cfg.logFormat} \

     

       114
       114
       +
                 -log.level ${cfg.logLevel} \

     

       115
       115
       +
                 -web.listen-address ${optionalString (cfg.listenAddress != null) cfg.listenAddress}:${toString cfg.port}

     

       116
       116
       +
             '';

     

       117
       117
       +
       

     

       118
       118
       +
             serviceConfig = {

     

       119
       119
       +
               User = cfg.user;

     

       120
       120
       +
               Group = cfg.group;

     

       121
       121
       +
               Restart  = "always";

     

       122
       122
       +
               PrivateTmp = true;

     

       123
       123
       +
               WorkingDirectory = "/tmp";

     

       124
       124
       +
             };

     

       125
       125
       +
           };

     

       126
       126
       +
         };

     

       127
       127
       +
       }