Ruby is a popular command processor available on Linux by default.
We have previously covered how to install Nagios monitoring server on Ubuntu 12.10 x64. This time, we will expand on this idea and create Nagios plugins using Ruby. These plugins will be running on client VPS, and be executed via NRPE.
apt-get install -y ruby nagios-nrpe-server useradd nrpe && update-rc.d nagios-nrpe-server defaults
It would be a good idea to keep your plugins in same directory as other Nagios plugins (/usr/lib/nagios/plugins/ for example).
For our example, we will create a script that checks current disk usage by calling "df" from shell, and throw an alert if it is over 85% used:
#!/usr/bin/ruby used_space=`df -h / | grep -v "Filesystem" | awk '{print $5}'` case used_space.chomp <=> "85%" when -1 puts "OK - #{used_space.chomp!} of disk space used." exit 0 when 0 puts "WARNING - #{used_space.chomp!} of disk space used." exit 1 when 1 puts "CRITICAL - #{used_space.chomp!} of disk space used." exit 2 else puts "UNKNOWN - #{used_space.chomp!} of disk space used." exit 3 end
We will save this script in /usr/lib/nagios/plugins/usedspace.rb and make it executable:
chmod +x /usr/lib/nagios/plugins/usedspace.rb
The entire Nagios NRPE plugin boils down to using exit codes to trigger alerts.
You introduce your level of logic to the script, and if you want to trigger an alert (whether it is OK, WARNING, CRITICAL, or UNKNOWN) - you specify an exit code.
Refer to the following Nagios Exit Codes:
Exit Code | Status |
0 | OK |
1 | WARNING |
2 | CRITICAL |
3 | UNKNOWN |
Delete original /etc/nagios/nrpe.cfg and add the following lines to it:
log_facility=daemon pid_file=/var/run/nagios/nrpe.pid server_port=5666 nrpe_user=nrpe nrpe_group=nrpe allowed_hosts=198.211.117.251 dont_blame_nrpe=1 debug=0 command_timeout=60 connection_timeout=300 include_dir=/etc/nagios/nrpe.d/ command[usedspace_ruby]=/usr/lib/nagios/plugins/usedspace.rb
Where 198.211.117.251 is our monitoring server from previous articles. Change these to your own values.
Make sure to restart Nagios NRPE service:
service nagios-nrpe-server restart
Define new command in /etc/nagios/objects/commands.cfg
define command{ command_name usedspace_ruby command_line $USER1$/check_nrpe -H $HOSTADDRESS$ -c usedspace_ruby }
As you can see, it uses NRPE to make TCP connections to port 5666 and run command 'usedspace_ruby', which we defined in /etc/nagios/nrpe.cfg on that remote host.
Add this check to your Nagios configuration file for client VPS.
For our example, we will monitor a server called UbuntuDroplet and edit /etc/nagios/servers/UbuntuDroplet.cfg
define service { use generic-service host_name UbuntuDroplet service_description Custom Disk Checker In Ruby check_command usedspace_ruby }
Restart Nagios:
service nagios restart
Verify that the new check is working:
And you are all done!
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
Sign up for Infrastructure as a Newsletter.
Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.
Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.