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, configuration, and implementation details for the xMatters On-Demand for Loggly integration via Zapier.
Loggly is a SaaS solution for log data management. The purpose of the integration is to inject events based on trends that Loggly observes in log files:
- The integration can be triggered off of any filter that you configure within Loggly
- You will need to provide authentication information for xMatters. It is recommended that you create a dedicated user account for submitting Loggly events.
- This integration is outbound from Loggly only (Loggly was not able to accept the web hook callbacks from xMatters.)
- Zapier (or a similar technology) is needed, since Loggly cannot send the event information directly to xMatters (Loggly couldn't provide the authentication information needed by xMatters).
- At the time of this development, there was no Loggly specific Trigger in Zapier, so we utilized the more generic Webhook connector to receive events from Loggly into Zapier.
Integration created and supplied by Sally Kim and Phil Petrella
Before you start...
You will need some things before you start:
- An account and login information for Zapier
- An account and login information for Loggly
- Access to your xMatters deployment, and the ability to create communication plans
Before configuring anything in Loggly, you'll need to configure xMatters.
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 the "REST Web Service User" role that includes the required 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 the Add New User icon.
- Enter the appropriate information for your new user (e.g. Username = loggly).
- Assign the user to the REST Web Service User role.
- Click Save.
- On the next page, set the web login ID and password. It is recommended that you use "loggly" for the User ID, so it is easily identified within your xMatters environment.
Loggly cannot send directly to a specific user or group within xMatters, but you can accomplish targeted notification by either creating subscriptions on the form, or by assigning a default recipient. You will need to create the target users and groups within xMatters that will receive notifications from events initiated by Loggly.
You can create multiple groups and users at once using the EPIC feature.
The next step is to import the loggly communication plan.
To import the Loggly communication plan:
- Download the attached Loggly.zip file to your system.
- In the target xMatters system, on the Developer tab, click Import Plan.
- Click Browse, and then locate the file you downloaded.
- Click Import Plan.
- Once the communication planhas been imported, click Plan Disabled to enable the plan.
- In the Edit drop-down list, select Forms.
- For the "Loggly Alert" 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 integration user you configured above, and then click Save Changes.
- On the Forms tab, In the Web Service Only drop-down list, click Access Web Service URL. Copy the highlighted URL at the top of the dialog box.
- 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.
Configuring Loggly to initiate events on the xMatters communication plan requires that you create a new Zap in Zapier, and then configure Loggly.
Now that you've configured xMatters, it's time to configure Zapier. Loggly is not an activated trigger in Zapier, but you can use the Web Hook set up.
In Zapier, first you need to create a Zap: Webhook in and xMatters out.
Second, you will generate the webhook URL that you will need in Loggly to send in events:
Third, you need to select and test your xMatters login:
Fourth, you can optionally specify filter criteria for when you want to trigger the "catch hook". We didn't specify any filter criteria and just let all events trigger the notification.
Fifth, you need to match up the inbound data from the webhook to the xMatters event layout:
Finally, you need to test and name the new Zap:
For more details about configuring Zapier, see the following article:
- Log in to Loggly and create a user account for xMatters.
- Create a Loggly alert, and select the Send to an endpoint check box.
- Click Add New, and then configure the endpoint as follows:
- Endpoint: select HTTP Endpoint
- Name: type the name to use for this endpoint.
- URL: paste the web hook URL from Zapier that we generated before.
- Method: Select POST
- Click Save to create the endpoint, and then save the alert.
To test the integration, send an alert from within Loggly.
To test the integration:
- Go to Zapier, and run the Zap you created.
- In Loggly, either force or wait for a new alert.