The information in this article is the intellectual property of xMatters and is intended only for use with xMatters products by xMatters customers and their employees. Further, this intellectual property is proprietary and must not be reused or resold.
There are limitless ways to exploit this feature but one good example is to quickly create an integration with a 3rd party product. Even though doing this using our REST API is a snip, there may be times when you need to create something quickly and this will solve the immediate problem at hand.
Here's an example of an email integration that we built with Nagios as a demonstration of how easily you can do it.
Nagios is an open source monitoring system used to monitor Hosts, Services and everything in between.
Integration Installation and Configuration
Installing the Nagios communication plan
Login to the xMatters user interface and navigate to the Developer tab > Manage Communication Plans > Import Plan.
Import the exported Nagios communication plan (attached to this page).
Click the checkbox to enable the plan:
Finally, grab the endpoint email address and note for later. Click Edit on the Nagios Plan > Forms to display the Nagios form. Click the Email Initiation drop down and select Set Up Email Initiation:
This will display the email mapping properties, but at the top will be the endpoint email address. It will be in the form of @nagios...xmatters.com. For example,email@example.com.
Set up Nagios
Login to the Nagios user interface. Navigate to the Configure tab > Core Config Manager.
In the Alerting section click Contacts to display all available contacts. Click the Add New button. Fill out the appropriate information, with the Email address from the endpoint above. Note that the username portion of the address can reference a user or group in xMatters. In this case the system will target the NagiosAdmin group within xMatters.
Click the Alert Settings tab. Make sure to enable the Host and/or Service notifications, or else Notifications won't fire! (See the Nagios documentation for details on the Service and Host Notification options section).
Click Save, which displays the list of contacts again. Click Apply Configuration to write the configuration to the system.
Finally, add the xMatters - NagiosAdmins contact to the services that will Alert through xMatters. In this example, the localhost SSH service will be used. In the Nagios Core Config Manager, click Monitoring > Services to display the list of available services.
Click localhost next to the SSH service to display the service details and click the Alert Settings tab. Make sure the "Notification enabled" radio button is set to "on".
Click Manage Contacts and add xMatters - NagiosAdmins to the Assigned column:
Click Close and Save to update the settings.
Click the username in the upper right corner:
Then click the notification preferences link:
Make sure to enable Email notifications in the Notification Methods
Nagios Integration Package - zip
Download (2 KB)
|Nagios Integration Package - tar.gz||
Download (2 KB)
JDN-4767 Originally created by Iain Rose