Tutorial

How To Create Nagios Plugins With PHP On Ubuntu 12.10

Published on April 29, 2013
author

Bulat Khamitov

How To Create Nagios Plugins With PHP On Ubuntu 12.10

Introduction

PHP is a popular programming language that allows you to quickly create scripts and install additional libraries.

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 PHP. These plugins will be running on client VPS, and be executed via NRPE.

Step 1 - Install NRPE on client VPS

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 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 PHP
        check_command                   usedspace_php
        }

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.

Learn more about our products


About the authors
Default avatar
Bulat Khamitov

author

Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
 
2 Comments


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!

Great tutorial: D

How do I run a given script every 25 seconds in Nagios ?

This is one of the best and straightforward tutorials on nagios out there. Thanks for writing this post Bulat. Really helped speed things up. You the man!

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

Featured on Community

Get our biweekly newsletter

Sign up for Infrastructure as a Newsletter.

Hollie's Hub for Good

Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.

Become a contributor

Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

Welcome to the developer cloud

DigitalOcean makes it simple to launch in the cloud and scale up as you grow — whether you're running one virtual machine or ten thousand.

Learn more
DigitalOcean Cloud Control Panel