commit 66bf75415f4e7a1571d41a2fed11838eb530376b · pyrox.dev/nixpkgs

+64 -49

nixos/modules/services/monitoring/nagios.nix

···

       17
        
             preferLocalBuild = true;

     

       18
        
           } "mkdir -p $out; ln -s $nagiosObjectDefs $out/";

     

       19
        
       

     

       20
       -
         nagiosCfgFile = pkgs.writeText "nagios.cfg"

     

       21
       -
           ''

     

       22
       -
             # Paths for state and logs.

     

       23
       -
             log_file=${nagiosLogDir}/current

     

       24
       -
             log_archive_path=${nagiosLogDir}/archive

     

       25
       -
             status_file=${nagiosState}/status.dat

     

       26
       -
             object_cache_file=${nagiosState}/objects.cache

     

       27
       -
             temp_file=${nagiosState}/nagios.tmp

     

       28
       -
             lock_file=/run/nagios.lock # Not used I think.

     

       29
       -
             state_retention_file=${nagiosState}/retention.dat

     

       30
       -
             query_socket=${nagiosState}/nagios.qh

     

       31
       -
             check_result_path=${nagiosState}

     

       32
       -
             command_file=${nagiosState}/nagios.cmd

     

       33
       -
       

     

       34
       -
             # Configuration files.

     

       35
       -
             #resource_file=resource.cfg

     

       36
       -
             cfg_dir=${nagiosObjectDefsDir}

     

       37
       -
       

     

       38
       -
             # Uid/gid that the daemon runs under.

     

       39
       -
             nagios_user=nagios

     

       40
       -
             nagios_group=nagios

     

       41
       -
       

     

       42
       -
             # Misc. options.

     

       43
       -
             illegal_macro_output_chars=`~$&|'"<>

     

       44
       -
             retain_state_information=1

     

       45
       -
           ''; # "

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       46
        
       

     

       47
        
         # Plain configuration for the Nagios web-interface with no

     

       48
        
         # authentication.

     
···

       77
        
           (mkRemovedOptionModule [ "services" "nagios" "urlPath" ] "The urlPath option has been removed as it is hard coded to /nagios in the nagios package.")

     

       78
        
         ];

     

       79
        
       

     

       0
        
       
     

       0
        
       
     

       80
        
         options = {

     

       81
        
           services.nagios = {

     

       82
       -
             enable = mkOption {

     

       83
       -
               default = false;

     

       84
       -
               description = "

     

       85
       -
                 Whether to use <link

     

       86
       -
                 xlink:href='http://www.nagios.org/'>Nagios</link> to monitor

     

       87
       -
                 your system or network.

     

       88
       -
               ";

     

       89
       -
             };

     

       90
        
       

     

       91
        
             objectDefs = mkOption {

     

       92
        
               description = "

     
···

       94
        
                 the hosts, host groups, services and contacts for the

     

       95
        
                 network that you want Nagios to monitor.

     

       96
        
               ";

     

       0
        
       
     

       0
        
       
     

       97
        
             };

     

       98
        
       

     

       99
        
             plugins = mkOption {

     

       100
        
               type = types.listOf types.package;

     

       101
       -
               default = [pkgs.nagiosPluginsOfficial pkgs.ssmtp];

     

       102
       -
               defaultText = "[pkgs.nagiosPluginsOfficial pkgs.ssmtp]";

     

       103
        
               description = "

     

       104
        
                 Packages to be added to the Nagios <envar>PATH</envar>.

     

       105
        
                 Typically used to add plugins, but can be anything.

     
···

       107
        
             };

     

       108
        
       

     

       109
        
             mainConfigFile = mkOption {

     

       110
       -
               type = types.package;

     

       111
       -
               default = nagiosCfgFile;

     

       112
       -
               defaultText = "nagiosCfgFile";

     

       113
        
               description = "

     

       114
       -
                 Derivation for the main configuration file of Nagios.

     

       115
        
               ";

     

       116
        
             };

     

       117
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       118
        
             cgiConfigFile = mkOption {

     

       119
        
               type = types.package;

     

       120
        
               default = nagiosCGICfgFile;

     
···

       126
        
             };

     

       127
        
       

     

       128
        
             enableWebInterface = mkOption {

     

       0
        
       
     

       129
        
               default = false;

     

       130
        
               description = "

     

       131
        
                 Whether to enable the Nagios web interface.  You should also

     
···

       165
        
           # This isn't needed, it's just so that the user can type "nagiostats

     

       166
        
           # -c /etc/nagios.cfg".

     

       167
        
           environment.etc = [

     

       168
       -
             { source = cfg.mainConfigFile;

     

       169
        
               target = "nagios.cfg";

     

       170
        
             }

     

       171
        
           ];

     
···

       173
        
           environment.systemPackages = [ pkgs.nagios ];

     

       174
        
           systemd.services.nagios = {

     

       175
        
             description = "Nagios monitoring daemon";

     

       176
       -
             path     = [ pkgs.nagios ];

     

       177
        
             wantedBy = [ "multi-user.target" ];

     

       178
        
             after    = [ "network.target" ];

     

       179
        
       

     
···

       184
        
               RestartSec = 2;

     

       185
        
               LogsDirectory = "nagios";

     

       186
        
               StateDirectory = "nagios";

     

       0
        
       
     

       0
        
       
     

       187
        
             };

     

       188
       -
       

     

       189
       -
             script = ''

     

       190
       -
               for i in ${toString cfg.plugins}; do

     

       191
       -
                 export PATH=$i/bin:$i/sbin:$i/libexec:$PATH

     

       192
       -
               done

     

       193
       -
               exec ${pkgs.nagios}/bin/nagios ${cfg.mainConfigFile}

     

       194
       -
             '';

     

       195
        
           };

     

       196
        
       

     

       197
        
           services.httpd.virtualHosts = optionalAttrs cfg.enableWebInterface {

···

       17
        
             preferLocalBuild = true;

     

       18
        
           } "mkdir -p $out; ln -s $nagiosObjectDefs $out/";

     

       19
        
       

     

       20
       +
         nagiosCfgFile = let

     

       21
       +
           default = {

     

       22
       +
             log_file="${nagiosLogDir}/current";

     

       23
       +
             log_archive_path="${nagiosLogDir}/archive";

     

       24
       +
             status_file="${nagiosState}/status.dat";

     

       25
       +
             object_cache_file="${nagiosState}/objects.cache";

     

       26
       +
             temp_file="${nagiosState}/nagios.tmp";

     

       27
       +
             lock_file="/run/nagios.lock";

     

       28
       +
             state_retention_file="${nagiosState}/retention.dat";

     

       29
       +
             query_socket="${nagiosState}/nagios.qh";

     

       30
       +
             check_result_path="${nagiosState}";

     

       31
       +
             command_file="${nagiosState}/nagios.cmd";

     

       32
       +
             cfg_dir="${nagiosObjectDefsDir}";

     

       33
       +
             nagios_user="nagios";

     

       34
       +
             nagios_group="nagios";

     

       35
       +
             illegal_macro_output_chars="`~$&|'\"<>";

     

       36
       +
             retain_state_information="1";

     

       37
       +
           };

     

       38
       +
           lines = mapAttrsToList (key: value: "${key}=${value}") (default // cfg.extraConfig);

     

       39
       +
           content = concatStringsSep "\n" lines;

     

       40
       +
           file = pkgs.writeText "nagios.cfg" content;

     

       41
       +
           validated =  pkgs.runCommand "nagios-checked.cfg" {preferLocalBuild=true;} ''

     

       42
       +
             cp ${file} nagios.cfg

     

       43
       +
             # nagios checks the existence of /var/lib/nagios, but

     

       44
       +
             # it does not exists in the build sandbox, so we fake it

     

       45
       +
             mkdir lib

     

       46
       +
             lib=$(readlink -f lib)

     

       47
       +
             sed -i s@=${nagiosState}@=$lib@ nagios.cfg

     

       48
       +
             ${pkgs.nagios}/bin/nagios -v nagios.cfg && cp ${file} $out

     

       49
       +
           '';

     

       50
       +
           defaultCfgFile = if cfg.validateConfig then validated else file;

     

       51
       +
         in

     

       52
       +
         if cfg.mainConfigFile == null then defaultCfgFile else cfg.mainConfigFile;

     

       53
        
       

     

       54
        
         # Plain configuration for the Nagios web-interface with no

     

       55
        
         # authentication.

     
···

       84
        
           (mkRemovedOptionModule [ "services" "nagios" "urlPath" ] "The urlPath option has been removed as it is hard coded to /nagios in the nagios package.")

     

       85
        
         ];

     

       86
        
       

     

       87
       +
         meta.maintainers = with lib.maintainers; [ symphorien ];

     

       88
       +
       

     

       89
        
         options = {

     

       90
        
           services.nagios = {

     

       91
       +
             enable = mkEnableOption "<link xlink:href='http://www.nagios.org/'>Nagios</link> to monitor your system or network.";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       92
        
       

     

       93
        
             objectDefs = mkOption {

     

       94
        
               description = "

     
···

       96
        
                 the hosts, host groups, services and contacts for the

     

       97
        
                 network that you want Nagios to monitor.

     

       98
        
               ";

     

       99
       +
               type = types.listOf types.path;

     

       100
       +
               example = literalExample "[ ./objects.cfg ]";

     

       101
        
             };

     

       102
        
       

     

       103
        
             plugins = mkOption {

     

       104
        
               type = types.listOf types.package;

     

       105
       +
               default = with pkgs; [ nagiosPluginsOfficial ssmtp mailutils ];

     

       106
       +
               defaultText = "[pkgs.nagiosPluginsOfficial pkgs.ssmtp pkgs.mailutils]";

     

       107
        
               description = "

     

       108
        
                 Packages to be added to the Nagios <envar>PATH</envar>.

     

       109
        
                 Typically used to add plugins, but can be anything.

     
···

       111
        
             };

     

       112
        
       

     

       113
        
             mainConfigFile = mkOption {

     

       114
       +
               type = types.nullOr types.package;

     

       115
       +
               default = null;

     

       0
        
       
     

       116
        
               description = "

     

       117
       +
                 If non-null, overrides the main configuration file of Nagios.

     

       118
        
               ";

     

       119
        
             };

     

       120
        
       

     

       121
       +
             extraConfig = mkOption {

     

       122
       +
               type = types.attrsOf types.str;

     

       123
       +
               example = {

     

       124
       +
                 debug_level = "-1";

     

       125
       +
                 debug_file = "/var/log/nagios/debug.log";

     

       126
       +
               };

     

       127
       +
               default = {};

     

       128
       +
               description = "Configuration to add to /etc/nagios.cfg";

     

       129
       +
             };

     

       130
       +
       

     

       131
       +
             validateConfig = mkOption {

     

       132
       +
               type = types.bool;

     

       133
       +
               default = pkgs.stdenv.hostPlatform == pkgs.stdenv.buildPlatform;

     

       134
       +
               description = "if true, the syntax of the nagios configuration file is checked at build time";

     

       135
       +
             };

     

       136
       +
       

     

       137
        
             cgiConfigFile = mkOption {

     

       138
        
               type = types.package;

     

       139
        
               default = nagiosCGICfgFile;

     
···

       145
        
             };

     

       146
        
       

     

       147
        
             enableWebInterface = mkOption {

     

       148
       +
               type = types.bool;

     

       149
        
               default = false;

     

       150
        
               description = "

     

       151
        
                 Whether to enable the Nagios web interface.  You should also

     
···

       185
        
           # This isn't needed, it's just so that the user can type "nagiostats

     

       186
        
           # -c /etc/nagios.cfg".

     

       187
        
           environment.etc = [

     

       188
       +
             { source = nagiosCfgFile;

     

       189
        
               target = "nagios.cfg";

     

       190
        
             }

     

       191
        
           ];

     
···

       193
        
           environment.systemPackages = [ pkgs.nagios ];

     

       194
        
           systemd.services.nagios = {

     

       195
        
             description = "Nagios monitoring daemon";

     

       196
       +
             path     = [ pkgs.nagios ] ++ cfg.plugins;

     

       197
        
             wantedBy = [ "multi-user.target" ];

     

       198
        
             after    = [ "network.target" ];

     

       199
        
       

     
···

       204
        
               RestartSec = 2;

     

       205
        
               LogsDirectory = "nagios";

     

       206
        
               StateDirectory = "nagios";

     

       207
       +
               ExecStart = "${pkgs.nagios}/bin/nagios /etc/nagios.cfg";

     

       208
       +
               X-ReloadIfChanged = nagiosCfgFile;

     

       209
        
             };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       210
        
           };

     

       211
        
       

     

       212
        
           services.httpd.virtualHosts = optionalAttrs cfg.enableWebInterface {

nixos/tests/all-tests.nix

···

       179
        
         mysql = handleTest ./mysql.nix {};

     

       180
        
         mysqlBackup = handleTest ./mysql-backup.nix {};

     

       181
        
         mysqlReplication = handleTest ./mysql-replication.nix {};

     

       0
        
       
     

       182
        
         nat.firewall = handleTest ./nat.nix { withFirewall = true; };

     

       183
        
         nat.firewall-conntrack = handleTest ./nat.nix { withFirewall = true; withConntrackHelpers = true; };

     

       184
        
         nat.standalone = handleTest ./nat.nix { withFirewall = false; };

···

       179
        
         mysql = handleTest ./mysql.nix {};

     

       180
        
         mysqlBackup = handleTest ./mysql-backup.nix {};

     

       181
        
         mysqlReplication = handleTest ./mysql-replication.nix {};

     

       182
       +
         nagios = handleTest ./nagios.nix {};

     

       183
        
         nat.firewall = handleTest ./nat.nix { withFirewall = true; };

     

       184
        
         nat.firewall-conntrack = handleTest ./nat.nix { withFirewall = true; withConntrackHelpers = true; };

     

       185
        
         nat.standalone = handleTest ./nat.nix { withFirewall = false; };

+116

nixos/tests/nagios.nix

···

       1
       +
       import ./make-test-python.nix (

     

       2
       +
         { pkgs, ... }: {

     

       3
       +
           name = "nagios";

     

       4
       +
           meta = with pkgs.stdenv.lib.maintainers; {

     

       5
       +
             maintainers = [ symphorien ];

     

       6
       +
           };

     

       7
       +
       

     

       8
       +
           machine = { lib, ... }: let

     

       9
       +
             writer = pkgs.writeShellScript "write" ''

     

       10
       +
               set -x

     

       11
       +
               echo "$@"  >> /tmp/notifications

     

       12
       +
             '';

     

       13
       +
           in

     

       14
       +
             {

     

       15
       +
               # tested service

     

       16
       +
               services.sshd.enable = true;

     

       17
       +
               # nagios

     

       18
       +
               services.nagios = {

     

       19
       +
                 enable = true;

     

       20
       +
                 # make state transitions faster

     

       21
       +
                 extraConfig.interval_length = "5";

     

       22
       +
                 objectDefs =

     

       23
       +
                   (map (x: "${pkgs.nagios}/etc/objects/${x}.cfg") [ "templates" "timeperiods" "commands" ]) ++ [

     

       24
       +
                     (

     

       25
       +
                       pkgs.writeText "objects.cfg" ''

     

       26
       +
                         # notifications are written to /tmp/notifications

     

       27
       +
                         define command {

     

       28
       +
                         command_name notify-host-by-file

     

       29
       +
                         command_line ${writer} "$HOSTNAME is $HOSTSTATE$"

     

       30
       +
                         }

     

       31
       +
                         define command {

     

       32
       +
                         command_name notify-service-by-file

     

       33
       +
                         command_line ${writer} "$SERVICEDESC$ is $SERVICESTATE$"

     

       34
       +
                         }

     

       35
       +
       

     

       36
       +
                         # nagios boilerplate

     

       37
       +
                         define contact {

     

       38
       +
                         contact_name                    alice

     

       39
       +
                         alias                           alice

     

       40
       +
                         host_notifications_enabled      1

     

       41
       +
                         service_notifications_enabled   1

     

       42
       +
                         service_notification_period     24x7

     

       43
       +
                         host_notification_period        24x7

     

       44
       +
                         service_notification_options    w,u,c,r,f,s

     

       45
       +
                         host_notification_options       d,u,r,f,s

     

       46
       +
                         service_notification_commands   notify-service-by-file

     

       47
       +
                         host_notification_commands      notify-host-by-file

     

       48
       +
                         email                           foo@example.com

     

       49
       +
                         }

     

       50
       +
                         define contactgroup {

     

       51
       +
                         contactgroup_name   admins

     

       52
       +
                         alias               Admins

     

       53
       +
                         members alice

     

       54
       +
                         }

     

       55
       +
                         define hostgroup{

     

       56
       +
                         hostgroup_name  allhosts

     

       57
       +
                         alias  All hosts

     

       58
       +
                         }

     

       59
       +
       

     

       60
       +
                         # monitored objects

     

       61
       +
                         define host {

     

       62
       +
                         use         generic-host

     

       63
       +
                         host_name   localhost

     

       64
       +
                         alias       localhost

     

       65
       +
                         address     localhost

     

       66
       +
                         hostgroups  allhosts

     

       67
       +
                         contact_groups admins

     

       68
       +
                         # make state transitions faster.

     

       69
       +
                         max_check_attempts 2

     

       70
       +
                         check_interval 1

     

       71
       +
                         retry_interval 1

     

       72
       +
                         }

     

       73
       +
                         define service {

     

       74
       +
                         use                 generic-service

     

       75
       +
                         host_name           localhost

     

       76
       +
                         service_description ssh

     

       77
       +
                         check_command       check_ssh

     

       78
       +
                         # make state transitions faster.

     

       79
       +
                         max_check_attempts 2

     

       80
       +
                         check_interval 1

     

       81
       +
                         retry_interval 1

     

       82
       +
                         }

     

       83
       +
                       ''

     

       84
       +
                     )

     

       85
       +
                   ];

     

       86
       +
               };

     

       87
       +
             };

     

       88
       +
       

     

       89
       +
           testScript = { ... }: ''

     

       90
       +
             with subtest("ensure sshd starts"):

     

       91
       +
                 machine.wait_for_unit("sshd.service")

     

       92
       +
       

     

       93
       +
       

     

       94
       +
             with subtest("ensure nagios starts"):

     

       95
       +
                 machine.wait_for_file("/var/log/nagios/current")

     

       96
       +
       

     

       97
       +
       

     

       98
       +
             def assert_notify(text):

     

       99
       +
                 machine.wait_for_file("/tmp/notifications")

     

       100
       +
                 real = machine.succeed("cat /tmp/notifications").strip()

     

       101
       +
                 print(f"got {real!r}, expected {text!r}")

     

       102
       +
                 assert text == real

     

       103
       +
       

     

       104
       +
       

     

       105
       +
             with subtest("ensure we get a notification when sshd is down"):

     

       106
       +
                 machine.succeed("systemctl stop sshd")

     

       107
       +
                 assert_notify("ssh is CRITICAL")

     

       108
       +
       

     

       109
       +
       

     

       110
       +
             with subtest("ensure tests can succeed"):

     

       111
       +
                 machine.succeed("systemctl start sshd")

     

       112
       +
                 machine.succeed("rm /tmp/notifications")

     

       113
       +
                 assert_notify("ssh is OK")

     

       114
       +
           '';

     

       115
       +
         }

     

       116
       +
       )

+11 -1

pkgs/servers/monitoring/nagios/default.nix

···

       1
       -
       { stdenv, fetchurl, perl, php, gd, libpng, zlib, unzip }:

     

       2
        
       

     

       3
        
       stdenv.mkDerivation rec {

     

       4
        
         pname = "nagios";

     
···

       20
        
           substituteInPlace Makefile --replace '$(MAKE) install-basic' ""

     

       21
        
         '';

     

       22
        
         installTargets = "install install-config";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       23
        
       

     

       24
        
         meta = {

     

       25
        
           description = "A host, service and network monitoring program";

···

       1
       +
       { stdenv, fetchurl, perl, php, gd, libpng, zlib, unzip, nixosTests }:

     

       2
        
       

     

       3
        
       stdenv.mkDerivation rec {

     

       4
        
         pname = "nagios";

     
···

       20
        
           substituteInPlace Makefile --replace '$(MAKE) install-basic' ""

     

       21
        
         '';

     

       22
        
         installTargets = "install install-config";

     

       23
       +
         postInstall = ''

     

       24
       +
           # don't make default files use hardcoded paths to commands

     

       25
       +
           sed -i 's@command_line *[^ ]*/\([^/]*\) @command_line \1 @'  $out/etc/objects/commands.cfg

     

       26
       +
           sed -i 's@/usr/bin/@@g' $out/etc/objects/commands.cfg

     

       27
       +
           sed -i 's@/bin/@@g' $out/etc/objects/commands.cfg

     

       28
       +
         '';

     

       29
       +
       

     

       30
       +
         passthru.tests = {

     

       31
       +
           inherit (nixosTests) nagios;

     

       32
       +
         };

     

       33
        
       

     

       34
        
         meta = {

     

       35
        
           description = "A host, service and network monitoring program";