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.
This article provides installation and configuration instructions when implementing the integration between xMatters On-Demand and AppDynamics.
AppDynamics is an application monitoring tool built for the enterprise. This integration allows you to send targeted push notifications, SMS, voice and email alerts when critical events are detected by your AppDynamics system.
The integration uses the HTTP Request Template feature in AppDynamics to inject events into xMatters based on criteria set within AppDynamics alerting policies.
This updated version of the integration takes advantage of the new HTTP Request Templates feature in AppDynamics, and the Integration Builder capabilities in xMatters On-Demand.
Check out our built-in integration
You can install a "built-in" version of this integration using the Integration Directory (Developer tab > Integrations). Built-in integrations are pre-configured for your xMatters: you don't need to download and import the communication plan, or follow the directions to configure xMatters as described below.
To configure this integration using the Integration Directory, see our online integration guide.
To continue setting up this packaged integration, use the following steps.
There are some tasks you can do ahead of time to make the configuration process a little smoother.
To begin, download the communication plan attached to this article; it contains everything needed for this integration.
Note: You do not need to extract the contents of the .zip file; you'll import the file directly into xMatters.
To begin setting up your integration, configure the xMatters components.
This integration requires a user who can authenticate REST web service calls when injecting events.
This user needs to be able to work with events, but does not need to update administrative settings. While you can use the default Company Supervisor role to authenticate REST web service calls, the best method is to create a user specifically for this integration with a dedicated "REST Web Service User" role that includes the permissions and capabilities.
Note: If you are installing this integration into an xMatters trial instance, you don't need to create a new user. Instead, locate the "Integration User" sample user that was automatically configured with the REST Web Service User role when your instance was created and assign them a new password. You can then skip ahead to the next section.
To create an integration user:
- Log in to the target xMatters system.
- On the Users tab, click Add.
- Enter the appropriate information for your new user. Because this user affects how messages appear for recipients and how events are displayed in the reports and Communication Center, you may want to identify the user as specific to this integration; for example:
- First Name: AppDynamics
- Last Name: Integration
- User ID: appdynamics
- Depending on your deployment, you might need to add one of the following roles so you can log in as the integration user and access the Developer tab: Full Access User, Developer or Limited Developer.
The integration will notify groups and users when AppDynamics sends events to xMatters. Users and groups must exist in xMatters before they can be listed as recipients:
The next step is to import the communication plan into xMatters.
To import the communication plan:
- In the target xMatters system, click Import Plan from the Developer tab.
- Click Choose File, and then locate the downloaded communication plan (.zip file).
- Click Import Plan.
- Importing the plan automatically enables it, and enable its forms for web services.
The form uses the default recipients specified on the Layout tab to determine who to notify about an incoming alert.
- On the Forms tab, beside the form, click Edit > Layout.
- In the Recipients section, add the default groups and users you want to receive notifications for AppDynamics events.
- Click Save Changes.
You need to retrieve the URL of the inbound integration to configure AppDynamics. (The following steps assume that you are using the URL Authentication option, which is the default setting for this communication plan. For more information about these options, see Inbound integration service authentication.)
To configure an inbound integration and retrieve its URL:
- Log out of xMatters, and then log back in as the integration user you configured above.
- Navigate to the Integration Builder tab for the AppDynamics communication plan, and expand the list of inbound integrations.
- Click the name of an integration.
- Scroll down to the bottom of the page, and click Copy URL beside the field:
Once you have retrieved the URLs, you can log the integration user out of xMatters.
Now that xMatters is ready to receive events, you can configure AppDynamics to send alerts into xMatters.
To configure AppDynamics:
- Log in to your AppDynamics controller, navigate to Alert & Respond > HTTP Request Templates, and then create a new template:
- Name the new channel "xMatters", and under Request URL, in the POST drop-down list, select POST.
- In the Raw URL field, paste the inbound integration URL:
- Under Payload, in the MIME Type drop-down list, select application/json.
- Copy the following code and paste it into the Payload text field:
#foreach( $event in $fullEventList )
}#if( $foreach.hasNext ),#end
- Save the HTTP Request Template.
You can run a quick test of the integration using Test > Run Test; and you should see a new event created in xMatters. To test the workflow and notifications, you can create a new action.
To test the integration:
- Create a new action in AppDynamics, and select Make An HTTP Request, using your xMatters HTTP Request Template:
- Assign this action to one of your policies to call the xMatters integration when that policy is triggered.