commit 421a18f42b93be350ca31cfd5fafd68f1caadeef · pyrox.dev/nixpkgs

nixos/modules/services/monitoring/prometheus/exporters.nix

···

       29
       29
        
           "fritzbox"

     

       30
       30
        
           "json"

     

       31
       31
        
           "mail"

     

       32
       32
       +
           "mikrotik"

     

       32
       33
        
           "minio"

     

       33
       34
        
           "nextcloud"

     

       34
       35
        
           "nginx"

     
···

       203
       204
        
             message = ''

     

       204
       205
        
               Please ensure you have either `services.prometheus.exporters.snmp.configuration'

     

       205
       206
        
                 or `services.prometheus.exporters.snmp.configurationPath' set!

     

       207
       207
       +
             '';

     

       208
       208
       +
           } {

     

       209
       209
       +
             assertion = cfg.mikrotik.enable -> (

     

       210
       210
       +
               (cfg.mikrotik.configFile == null) != (cfg.mikrotik.configuration == null)

     

       211
       211
       +
             );

     

       212
       212
       +
             message = ''

     

       213
       213
       +
               Please specify either `services.prometheus.exporters.mikrotik.configuration'

     

       214
       214
       +
                 or `services.prometheus.exporters.mikrotik.configFile'.

     

       206
       215
        
             '';

     

       207
       216
        
           } {

     

       208
       217
        
             assertion = cfg.mail.enable -> (

+66

nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.prometheus.exporters.mikrotik;

     

       7
       7
       +
       in

     

       8
       8
       +
       {

     

       9
       9
       +
         port = 9436;

     

       10
       10
       +
         extraOpts = {

     

       11
       11
       +
           configFile = mkOption {

     

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

     

       13
       13
       +
             default = null;

     

       14
       14
       +
             description = ''

     

       15
       15
       +
               Path to a mikrotik exporter configuration file. Mutually exclusive with

     

       16
       16
       +
               <option>configuration</option> option.

     

       17
       17
       +
             '';

     

       18
       18
       +
             example = literalExample "./mikrotik.yml";

     

       19
       19
       +
           };

     

       20
       20
       +
       

     

       21
       21
       +
           configuration = mkOption {

     

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

     

       23
       23
       +
             default = null;

     

       24
       24
       +
             description = ''

     

       25
       25
       +
               Mikrotik exporter configuration as nix attribute set. Mutually exclusive with

     

       26
       26
       +
               <option>configFile</option> option.

     

       27
       27
       +
       

     

       28
       28
       +
               See <link xlink:href="https://github.com/nshttpd/mikrotik-exporter/blob/master/README.md"/>

     

       29
       29
       +
               for the description of the configuration file format.

     

       30
       30
       +
             '';

     

       31
       31
       +
             example = literalExample ''

     

       32
       32
       +
               {

     

       33
       33
       +
                 devices = [

     

       34
       34
       +
                   {

     

       35
       35
       +
                     name = "my_router";

     

       36
       36
       +
                     address = "10.10.0.1";

     

       37
       37
       +
                     user = "prometheus";

     

       38
       38
       +
                     password = "changeme";

     

       39
       39
       +
                   }

     

       40
       40
       +
                 ];

     

       41
       41
       +
                 features = {

     

       42
       42
       +
                   bgp = true;

     

       43
       43
       +
                   dhcp = true;

     

       44
       44
       +
                   routes = true;

     

       45
       45
       +
                   optics = true;

     

       46
       46
       +
                 };

     

       47
       47
       +
               }

     

       48
       48
       +
             '';

     

       49
       49
       +
           };

     

       50
       50
       +
         };

     

       51
       51
       +
         serviceOpts = let

     

       52
       52
       +
           configFile = if cfg.configFile != null

     

       53
       53
       +
                        then cfg.configFile

     

       54
       54
       +
                        else "${pkgs.writeText "mikrotik-exporter.yml" (builtins.toJSON cfg.configuration)}";

     

       55
       55
       +
           in {

     

       56
       56
       +
           serviceConfig = {

     

       57
       57
       +
             # -port is misleading name, it actually accepts address too

     

       58
       58
       +
             ExecStart = ''

     

       59
       59
       +
               ${pkgs.prometheus-mikrotik-exporter}/bin/mikrotik-exporter \

     

       60
       60
       +
                 -config-file=${escapeShellArg configFile} \

     

       61
       61
       +
                 -port=${cfg.listenAddress}:${toString cfg.port} \

     

       62
       62
       +
                 ${concatStringsSep " \\\n  " cfg.extraFlags}

     

       63
       63
       +
             '';

     

       64
       64
       +
           };

     

       65
       65
       +
         };

     

       66
       66
       +
       }

+40

nixos/tests/prometheus-exporters.nix

···

       245
       245
        
             '';

     

       246
       246
        
           };

     

       247
       247
        
       

     

       248
       248
       +
           mikrotik = {

     

       249
       249
       +
             exporterConfig = {

     

       250
       250
       +
               enable = true;

     

       251
       251
       +
               extraFlags = [ "-timeout=1s" ];

     

       252
       252
       +
               configuration = {

     

       253
       253
       +
                 devices = [

     

       254
       254
       +
                   {

     

       255
       255
       +
                     name = "router";

     

       256
       256
       +
                     address = "192.168.42.48";

     

       257
       257
       +
                     user = "prometheus";

     

       258
       258
       +
                     password = "shh";

     

       259
       259
       +
                   }

     

       260
       260
       +
                 ];

     

       261
       261
       +
                 features = {

     

       262
       262
       +
                   bgp = true;

     

       263
       263
       +
                   dhcp = true;

     

       264
       264
       +
                   dhcpl = true;

     

       265
       265
       +
                   dhcpv6 = true;

     

       266
       266
       +
                   health = true;

     

       267
       267
       +
                   routes = true;

     

       268
       268
       +
                   poe = true;

     

       269
       269
       +
                   pools = true;

     

       270
       270
       +
                   optics = true;

     

       271
       271
       +
                   w60g = true;

     

       272
       272
       +
                   wlansta = true;

     

       273
       273
       +
                   wlanif = true;

     

       274
       274
       +
                   monitor = true;

     

       275
       275
       +
                   ipsec = true;

     

       276
       276
       +
                 };

     

       277
       277
       +
               };

     

       278
       278
       +
             };

     

       279
       279
       +
             exporterTest = ''

     

       280
       280
       +
               wait_for_unit("prometheus-mikrotik-exporter.service")

     

       281
       281
       +
               wait_for_open_port(9436)

     

       282
       282
       +
               succeed(

     

       283
       283
       +
                   "curl -sSf http://localhost:9436/metrics | grep -q 'mikrotik_scrape_collector_success{device=\"router\"} 0'"

     

       284
       284
       +
               )

     

       285
       285
       +
             '';

     

       286
       286
       +
           };

     

       287
       287
       +
       

     

       248
       288
        
           nextcloud = {

     

       249
       289
        
             exporterConfig = {

     

       250
       290
        
               enable = true;

pkgs/top-level/all-packages.nix

···

       15797
       15797
        
         prometheus-json-exporter = callPackage ../servers/monitoring/prometheus/json-exporter.nix { };

     

       15798
       15798
        
         prometheus-mail-exporter = callPackage ../servers/monitoring/prometheus/mail-exporter.nix { };

     

       15799
       15799
        
         prometheus-mesos-exporter = callPackage ../servers/monitoring/prometheus/mesos-exporter.nix { };

     

       15800
       15800
       +
         prometheus-mikrotik-exporter = callPackage ../servers/monitoring/prometheus/mikrotik-exporter.nix { };

     

       15800
       15801
        
         prometheus-minio-exporter = callPackage ../servers/monitoring/prometheus/minio-exporter { };

     

       15801
       15802
        
         prometheus-mysqld-exporter = callPackage ../servers/monitoring/prometheus/mysqld-exporter.nix { };

     

       15802
       15803
        
         prometheus-nextcloud-exporter = callPackage ../servers/monitoring/prometheus/nextcloud-exporter.nix { };