Contribution:IP Monitor

From WHMCS Documentation

Jump to: navigation, search

User contribution: IP Monitoring Addon by Matt (See all by this user)

This IP Monitoring addon is developed for use by hosting companies to monitor their servers & ports. It is being offered as a free addon for WHMCS as I think others will find it useful just like I have. As a free addon, support will only be provided via the forums.

Download latest version (1.0.0)


Contribution:IP Monitor
All documented contributions | Document your own contribution


Installation

  1. Create the directory /modules/admin/ip_monitor/
  2. Upload both the files from the zip file into it
  3. Setup a cron job to run the monitor using the command shown in the monitoring page - it can run as often as you like

Usage

To access the IP Monitor addon, go to Utilities > Addon Modules > Ip Monitor

Begin by configuring the default ports to monitor and default notification emails. These apply to all IPs you setup to monitor and can be changed at any time. You would put the common ports here such as port 80 (http) and 110 (pop). You can seperate multiple ports and email addresses with commas.

Adding an IP for monitoring

To add an IP, simply enter a name that can define what it is to you and the IP address in the boxes at the top of the page and click the Add IP button. It will then be added to the list below.

Managing IPs being Monitored

From the IP monitor, you can view and edit the IPs which are being monitored. You can add additional ports and/or notification emails for that specific IP - for example you may wish to have an email sent to an address which forwards to your phone via SMS for only certain important IPs. These do not overide the defaults, but are in addition to them.

The table also displays the last time a check was made and if any ports were down at that time will show which ports also.

You can delete the IP and stop all future monitoring by clicking the delete icon to the right of the row.

Notifications

If when a check is run a service is found to be down, you will be sent an email which looks like the one below:

The following service is down.
---------------------------------------
Name: Example Service
IP Address: 12.234.56.78
Port: 80
---------------------------------------

On the next check, if the service is still down, you won't receive another email - this is to prevent you being bombarded with notifications. The next notification you receive will be when the service is found to be back up again, and then you will get an email which looks like this:

The following service was down previously but is now up again.
---------------------------------------
Name: Example Service
IP Address: 12.234.56.78
Port: 80
---------------------------------------

Limitations

Obviously for the checks to work it relies on your WHMCS server being online but being as WHMCS is your client management and support area this should be online more than most and so able to monitor all the other servers that you have.