commit fe907aa37e182a5abaf0bb2549b5a40b6c45cce0 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2311.section.md

···

       30
       30
        
       

     

       31
       31
        
       - [Anuko Time Tracker](https://github.com/anuko/timetracker), a simple, easy to use, open source time tracking system. Available as [services.anuko-time-tracker](#opt-services.anuko-time-tracker.enable).

     

       32
       32
        
       

     

       33
       33
       +
       - [Prometheus MySQL exporter](https://github.com/prometheus/mysqld_exporter), a MySQL server exporter for Prometheus. Available as [services.prometheus.exporters.mysqld](#opt-services.prometheus.exporters.mysqld.enable).

     

       34
       34
       +
       

     

       33
       35
        
       - [sitespeed-io](https://sitespeed.io), a tool that can generate metrics (timings, diagnostics) for websites. Available as [services.sitespeed-io](#opt-services.sitespeed-io.enable).

     

       34
       36
        
       

     

       35
       37
        
       - [Jool](https://nicmx.github.io/Jool/en/index.html), an Open Source implementation of IPv4/IPv6 translation on Linux. Available as [networking.jool.enable](#opt-networking.jool.enable).

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

···

       50
       50
        
           "mikrotik"

     

       51
       51
        
           "minio"

     

       52
       52
        
           "modemmanager"

     

       53
       53
       +
           "mysqld"

     

       53
       54
        
           "nextcloud"

     

       54
       55
        
           "nginx"

     

       55
       56
        
           "nginxlog"

     
···

       295
       296
        
             message = ''

     

       296
       297
        
               Please specify either 'services.prometheus.exporters.mail.configuration'

     

       297
       298
        
                 or 'services.prometheus.exporters.mail.configFile'.

     

       299
       299
       +
             '';

     

       300
       300
       +
           } {

     

       301
       301
       +
             assertion = cfg.mysqld.runAsLocalSuperUser -> config.services.mysql.enable;

     

       302
       302
       +
             message = ''

     

       303
       303
       +
               The exporter is configured to run as 'services.mysql.user', but

     

       304
       304
       +
                 'services.mysql.enable' is set to false.

     

       298
       305
        
             '';

     

       299
       306
        
           } {

     

       300
       307
        
             assertion = cfg.sql.enable -> (

+60

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

···

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

     

       2
       2
       +
       let

     

       3
       3
       +
         cfg = config.services.prometheus.exporters.mysqld;

     

       4
       4
       +
         inherit (lib) types mkOption mdDoc mkIf mkForce cli concatStringsSep optionalString escapeShellArgs;

     

       5
       5
       +
       in {

     

       6
       6
       +
         port = 9104;

     

       7
       7
       +
         extraOpts = {

     

       8
       8
       +
           telemetryPath = mkOption {

     

       9
       9
       +
             type = types.str;

     

       10
       10
       +
             default = "/metrics";

     

       11
       11
       +
             description = mdDoc ''

     

       12
       12
       +
               Path under which to expose metrics.

     

       13
       13
       +
             '';

     

       14
       14
       +
           };

     

       15
       15
       +
       

     

       16
       16
       +
           runAsLocalSuperUser = mkOption {

     

       17
       17
       +
             type = types.bool;

     

       18
       18
       +
             default = false;

     

       19
       19
       +
             description = mdDoc ''

     

       20
       20
       +
               Whether to run the exporter as {option}`services.mysql.user`.

     

       21
       21
       +
             '';

     

       22
       22
       +
           };

     

       23
       23
       +
       

     

       24
       24
       +
           configFile = mkOption {

     

       25
       25
       +
             type = types.path;

     

       26
       26
       +
             example = "/var/lib/prometheus-mysqld-exporter.cnf";

     

       27
       27
       +
             description = mdDoc ''

     

       28
       28
       +
               Path to the services config file.

     

       29
       29
       +
       

     

       30
       30
       +
               See <https://github.com/prometheus/mysqld_exporter#running> for more information about

     

       31
       31
       +
               the available options.

     

       32
       32
       +
       

     

       33
       33
       +
               ::: {.warn}

     

       34
       34
       +
               Please do not store this file in the nix store if you choose to include any credentials here,

     

       35
       35
       +
               as it would be world-readable.

     

       36
       36
       +
               :::

     

       37
       37
       +
             '';

     

       38
       38
       +
           };

     

       39
       39
       +
         };

     

       40
       40
       +
       

     

       41
       41
       +
         serviceOpts = {

     

       42
       42
       +
           serviceConfig = {

     

       43
       43
       +
             DynamicUser = !cfg.runAsLocalSuperUser;

     

       44
       44
       +
             User = mkIf cfg.runAsLocalSuperUser (mkForce config.services.mysql.user);

     

       45
       45
       +
             LoadCredential = mkIf (cfg.configFile != null) (mkForce ("config:" + cfg.configFile));

     

       46
       46
       +
             ExecStart = concatStringsSep " " [

     

       47
       47
       +
               "${pkgs.prometheus-mysqld-exporter}/bin/mysqld_exporter"

     

       48
       48
       +
               "--web.listen-address=${cfg.listenAddress}:${toString cfg.port}"

     

       49
       49
       +
               "--web.telemetry-path=${cfg.telemetryPath}"

     

       50
       50
       +
               (optionalString (cfg.configFile != null) ''--config.my-cnf=''${CREDENTIALS_DIRECTORY}/config'')

     

       51
       51
       +
               (escapeShellArgs cfg.extraFlags)

     

       52
       52
       +
             ];

     

       53
       53
       +
             RestrictAddressFamilies = [

     

       54
       54
       +
               # The exporter can be configured to talk to a local mysql server via a unix socket.

     

       55
       55
       +
               "AF_UNIX"

     

       56
       56
       +
             ];

     

       57
       57
       +
           };

     

       58
       58
       +
         };

     

       59
       59
       +
       }

     

       60
       60
       +

+35

nixos/tests/prometheus-exporters.nix

···

       716
       716
        
             '';

     

       717
       717
        
           };

     

       718
       718
        
       

     

       719
       719
       +
           mysqld = {

     

       720
       720
       +
             exporterConfig = {

     

       721
       721
       +
               enable = true;

     

       722
       722
       +
               runAsLocalSuperUser = true;

     

       723
       723
       +
               configFile = pkgs.writeText "test-prometheus-exporter-mysqld-config.my-cnf" ''

     

       724
       724
       +
                 [client]

     

       725
       725
       +
                 user = exporter

     

       726
       726
       +
                 password = snakeoilpassword

     

       727
       727
       +
               '';

     

       728
       728
       +
             };

     

       729
       729
       +
             metricProvider = {

     

       730
       730
       +
               services.mysql = {

     

       731
       731
       +
                 enable = true;

     

       732
       732
       +
                 package = pkgs.mariadb;

     

       733
       733
       +
                 initialScript = pkgs.writeText "mysql-init-script.sql" ''

     

       734
       734
       +
                   CREATE USER 'exporter'@'localhost'

     

       735
       735
       +
                   IDENTIFIED BY 'snakeoilpassword'

     

       736
       736
       +
                   WITH MAX_USER_CONNECTIONS 3;

     

       737
       737
       +
                   GRANT PROCESS, REPLICATION CLIENT, SLAVE MONITOR, SELECT ON *.* TO 'exporter'@'localhost';

     

       738
       738
       +
                 '';

     

       739
       739
       +
               };

     

       740
       740
       +
             };

     

       741
       741
       +
             exporterTest = ''

     

       742
       742
       +
               wait_for_unit("prometheus-mysqld-exporter.service")

     

       743
       743
       +
               wait_for_open_port(9104)

     

       744
       744
       +
               wait_for_unit("mysql.service")

     

       745
       745
       +
               succeed("curl -sSf http://localhost:9104/metrics | grep 'mysql_up 1'")

     

       746
       746
       +
               systemctl("stop mysql.service")

     

       747
       747
       +
               succeed("curl -sSf http://localhost:9104/metrics | grep 'mysql_up 0'")

     

       748
       748
       +
               systemctl("start mysql.service")

     

       749
       749
       +
               wait_for_unit("mysql.service")

     

       750
       750
       +
               succeed("curl -sSf http://localhost:9104/metrics | grep 'mysql_up 1'")

     

       751
       751
       +
             '';

     

       752
       752
       +
           };

     

       753
       753
       +
       

     

       719
       754
        
           nextcloud = {

     

       720
       755
        
             exporterConfig = {

     

       721
       756
        
               enable = true;