OpsGenie Integration Guide

  • 2 minute(s) read
Prev Next

Summary

The purpose of the web performance monitoring industry is to help ensure the quality of service of online systems. A vital part of achieving that goal is a robust alerting system that informs you of the widest possible variety of conditions, including:

  • Availability of service and content
  • Delivery speed and user experience
  • Page size and number of requests
  • Content validation
  • JavaScript failures
  • Thresholds applied to custom data sources

On top of that, a comprehensive alerting system must offer different thresholds and priority-levels for incidents based on such factors as time, event-type, location, individual measurements, historical values, and statistical values. It is with these goals of comprehensive analytics and alerting in mind that Catchpoint now includes integration with OpsGenie.

OpsGenie delivers comprehensive alerts to the right people, enabling them to assess each incident and take appropriate actions promptly. Email and SMS delivery times can be unpredictable. OpsGenie provides mobile apps to take advantage of push-notification technology for near-realtime alerting, and allows users to define multiple notification methods that can be triggered in succession. Now, with the Catchpoint Alert Push API, you can easily send custom alerts from Catchpoint to the OpsGenie platform.

Integration Steps

OpsGenie Setup

  1. Login to the OpsGenie portal, you will be redirected to the home page:
    1.png

  2. To complete the integration, you would need to create a team. Click on "Add Team" button and fill in the required details and click on Add Item, once done a team will be created.
    2.png

  3. Now you will be redirected to your created team.rom here you need to complete the integration.
    Click on Integration option in the left pane
    3.png

4a.png

  1. You would land in the following landing page of Integration module
    5.png

  2. Copy the API key to the clipboard, as you will need this when you configure the Catchpoint Push Alert API.

Catchpoint Setup

  1. Log in to the Catchpoint Portal and go to Settings > API
  2. In the Alerts API section, paste in the OpsGenie API URL: https://api.opsgenie.com/v1/json/alert
  3. Choose Template as the Alert Format. Click Add New and you will be taken to the Edit Template window.
  4. Give the Template a name and set the Format to Text.
  5. The text template must be formatted per OpsGenie API guidelines. At a minimum, you need to include the API Key, a message, and teams to send the alert to. (See example below)
  6. The text can include Catchpoint Alert API Macros that will allow you to include information available at runtime, such as the name of the test that generated the alert and the alert severity. A full list of the Alert API Macros can be found here: https://docs.catchpoint.com/docs/alert-webhook-macro-index
{
    "apiKey": "e99fda4e-xxxx-xxxx-xxxx-656fcb3fecc4",
    "message":"${switch(${notificationLevelId},'0','WARNING','1','CRITICAL','3','OK')}
    - ${TestName}",
    "teams" : ["operations", "developers"]
}
  1. Save your template and Save the API configuration.

Any new alerts generated by your Catchpoint tests will now begin appearing in the OpsGenie Portal.