Home » Categories » Multiple Categories

How To Create Nagios Plugins With PHP On Ubuntu 12.10

Step 1 - Install NRPE on client

apt-get install -y php5 nagios-nrpe-server
useradd nrpe && update-rc.d nagios-nrpe-server defaults

Step 2 - Create your PHP Script

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:
$used_space=chop(shell_exec("df -h / | grep -v Filesystem | awk '{print $5}'"));

switch ($used_space) {
        case "$used_space" < "85%":
        print "OK - $used_space of disk space used.";

        case "$used_space" == "85%":
        print "WARNING - $used_space of disk space used.";

        case $used_space > "85%":
        print "CRITICAL - $used_space of disk space used.";

        print "UNKNOWN - $used_space of disk space used.";

We will save this script in /usr/lib/nagios/plugins/usedspace.php and make it executable:
chmod +x /usr/lib/nagios/plugins/usedspace.php

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:

Nagios Exit Codes

Exit Code Status
0 OK

Step 3 - Add Your Script to NRPE configuration on client host

Delete original /etc/nagios/nrpe.cfg and add the following lines to it:


Where 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

Step 4 - Add Your New Command to Nagios Checks on Nagios Monitoring Server

Define new command in /etc/nagios/objects/commands.cfg
define command{
        command_name    usedspace_php
        command_line    $USER1$/check_nrpe -H $HOSTADDRESS$ -c usedspace_php

As you can see, it uses NRPE to make TCP connections to port 5666 and run command 'usedspace_php', which we defined in /etc/nagios/nrpe.cfg on that remote host.
Add this check to your Nagios configuration file for client.
For our example, we will monitor a server called MyUbuntu and edit /etc/nagios/servers/MyUbuntu.cfg
define service {
        use                             generic-service
        host_name                       MyUbuntu
        service_description             Custom Disk Checker In PHP
        check_command                   usedspace_php

Restart Nagios:
service nagios restart

Verify that the new check is working. And you are all done!
Attachments Attachments
There are no attachments for this article.
Related Articles RSS Feed
How To Install Linux, Nginx, MySQL, PHP (LEMP) Stack on Debian 7
Viewed 2378 times since Fri, Dec 27, 2013
How to Setup a Multi-Protocol VPN Server Using SoftEther
Viewed 4297 times since Thu, Jan 2, 2014
How To Install (LEMP) nginx, MySQL, PHP stack on Arch Linux
Viewed 3048 times since Sun, Dec 29, 2013
How To Set Up mod_security with Apache on Debian/Ubuntu
Viewed 2771 times since Thu, Dec 26, 2013
How To Set Up an NFS Mount on Ubuntu 12.04
Viewed 4834 times since Tue, Dec 24, 2013
How To Set Up vsftpd on Ubuntu 12.04
Viewed 1483 times since Thu, Dec 26, 2013
How To Scale Django: Finding the Bottleneck
Viewed 1735 times since Fri, Jan 3, 2014
Top 10 Linux Easter Eggs
Viewed 2386 times since Sat, Jan 4, 2014
How To Install Linux, Apache, MySQL, PHP (LAMP) stack on Ubuntu
Viewed 2019 times since Thu, Jan 2, 2014