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:
#!/usr/bin/php
<?php
$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.";
        exit(0);

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

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

        default:
        print "UNKNOWN - $used_space of disk space used.";
        exit(3);
}
?>



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
1 WARNING
2 CRITICAL
3 UNKNOWN

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


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_php]=/usr/lib/nagios/plugins/usedspace.php

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

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 Opigno on Debian 7 with Git and Drush
Viewed 2396 times since Sat, Jan 4, 2014
How to Setup Tiki Wiki on Ubuntu 12.10
Viewed 3187 times since Thu, Jan 2, 2014
How To Use WP-CLI to Manage your WordPress Site from the Command Line
Viewed 8457 times since Sat, Jan 4, 2014
How To Configure Secure Updates and Installations in WordPress on Ubuntu
Viewed 3813 times since Sat, Jan 4, 2014
Top 10 Linux Easter Eggs
Viewed 2201 times since Sat, Jan 4, 2014
How To Create Nagios Plugins With PHP On CentOS 6
Viewed 1725 times since Sat, Jan 4, 2014
How To Set Up ProFTPD on CentOS 6
Viewed 1619 times since Thu, Jan 2, 2014
What is FTP and How Is It Used?
Viewed 1377 times since Fri, Dec 27, 2013
How To Set Up vsftpd on CentOS 6
Viewed 1312 times since Thu, Dec 26, 2013
How To Set Up vsftpd on Ubuntu 12.04
Viewed 1359 times since Thu, Dec 26, 2013