BMC TrueSight Pulse provides easy to use alarms, which are triggered when the monitored metric crosses a defined threshold. Each alarm can be connected to one or more actions so that users can be notified when an alarm status changes. When your account is created, TrueSight Pulse provisions several simple alarms and connects them to the e-mail action to get you started. Customers who use different collaboration tools can easily create more actions and attach them to alarms. This article describes how to integrate with the popular xMatters service.
Before configuring anything in BMC TrueSight Pulse, xMatters will need to be configured first.
Create a REST API user
The first step in configuring xMatters is to create a REST API user to authenticate REST web service calls when injecting events.
This user needs to be able to work with events, but not update administrative settings. The best way to create a user for this integration is to have a dedicated "Full Access User" role that includes the permissions and capabilities. If this role does not exist in your deployment, you will need to create it, or ask your xMatters Client Success Manager to create it for you. (For detailed procedures about creating the role, see help article Authentication and Permissions at xMatters Support site).
In the following example, this user is named "BoundaryAPI". To create a REST API user:
- Log in to the target xMatters system.
- On the Users tab, click the Add User button.
- Enter the appropriate information for your new user.
- Assign the user to the Full Access User role.
- Click Save.
- On the next page, set the web login ID and password.
- Make a note of these details; you will need them when configuring the Boundary side of the integration.
Create users and groups that will receive notifications
Recipients to the TrueSight Pulse alarms will be set in the action when it is created in BMC TrueSight Pulse. See below for details.
- To create a new group, see Create a New Group (-> xMatters support site).
- To create a new user, see Add a New User (-> xMatters support site).
- You can create multiple groups and users at once using the EPIC (-> xMatters support site).
Import the relevance engine
The next step is to import the Boundary relevance engine:
- Download the attached file Boundary.zip to your system.
- In the target xMatters system, on the Developer tab, click Import Engine.
- Click Choose File, locate the file downloaded in step 1 and click Import Engine.
- Once the relevance engine has been imported, click Engine Disabled to enable the engine.
- In the Edit drop-down list, select Forms.
- For the CPU Action form, in the Not Deployed drop-down list, click Create Event Web Service.
- After you create the web service, the drop-down list label will change to Web Service Only.
- In the Web Service Only drop-down list, click Permissions.
- Enter the "BoundaryAPI" you created above, and then click Save Changes.
- Repeat steps 7-9 for the Memory Action form.
- To get the web service URL for a form, in the Web Service Only drop-down list, click Access Web Service URL. Copy the highlighted URL at the top of the dialog box.
- Note that the Access Web Service URL option appears twice in the drop-down menu. Ensure that you click the option just below Create Event Web Service.
- You'll need these URLs when you configure the Boundary action.
Once it is done, let us head back to your account in Boundary. From here it is straightforward.
Add xMatters Action to BMC TrueSight Pulse
First, let us add the xMatters Action to your BMC TrueSight Pulse account. Click "Settings" on left toolbar to open the dialog and go to Actions tab. Click on the "Add Action" button and select "xMatters" on the next screen and click "Add".
You will find yourself on the "xMatters" configuration page. It has just several fields, described below.
|Name||Name of the action; this should be the same as the form name in xMatters.|
|Endpoint URL||The REST API endpoint. This is the URL copied from the form as described in the "Import relevance engine" section, above.|
|Username||The REST API User's name to authenticate to xMatters.|
|Password||The password for the REST API User above.|
|Target Group or User||The Group or User this action should target. Note that if you are using a subscription, this is not required.|
|Priority||Determines the message send priority - choose from drop-down list|
After you filled the fields, click "Save".
Now you should have xMatters action ready to be used.
Connect alarms to the xMatters Action
The last step would be attach it to new or existing Alarms. For my test, I attached it to the default CPU Utilization alarm and lowered the threshold, to make sure the alarm is triggered.
A bit later, I was able to see notifications in the my xMatters account.
That's it! You can define more xMatters actions with different severity or re-use the same xMatters Action in multiple alarms.