Product Documentation

Catchpoint

Type of Data

Alerts

Data Feed Format

Here is a sample of the JSON structure that will be fed to the Openmix app:

  {
    "alerting_nodes": {
      "markets": {
      "NA": 4
    },
    "countries": {
      "US": 3,
      "CA": 1
    }
  },
    "health_score": {
      "unit": "0-5",
      "value": 0
    },
    "bypass_data_points": true
  }

Server Configuration

Setting up the Catchpoint Fusion data feed requires these high level steps:

  • Login to Catchpoint portal
  • Configure the desired alert on the Catchpoint nodes that should execute the check
  • Modify Catchpoint configuration to use Webhook callback notification
  • Install Fusion Catchpoint data feed

Configure Catchpoint Alert

  • The Catchpoint setup will typically have products defined which is a way of creating templates as a starting point for creating a new Catchpoint alarm. Catchpoint preselects many of the options for creating a test such as which CP nodes to run the test on (the CP network), the frequency in which to run the tests, etc.
  • To create a new Catchpoint test, select a product and click Create. For this example we will do a Web URL availability check.
  • Fill out the properties of the test. Expand the “Show advance settings” to see additional options that are available for the test. There are also selections for “Request”, “Target and Scheduling” and “Alerts”. By default, the “Inherit” option is selected. the “Target and Scheduling” tab is where you can change which Catchpoint networks will run the check and the frequency. You can override any of the default settings by clicking the “Override” button.
  • Once the test is setup as desired, click save. The new test will be listed and made “Active” in the product listing.
  • Because Fusion is receiving a Webhook notifications for Catchpoint alarms, the last step is to configure the Catchpoint Webhook callback URL. This is a “global” callback notification for all alarms configured in the Catchpoint portal so you may not able to configure the Webhook notification for a single Catchpoint check
  • To create the Webhook callback URL in Catchpoint, navigate to the Gear Menu Icon and choose API, the following screen is displayed. The data push API section should be blank as you are setting up the global Webhook callback for all Catchpoint alarms. If it is not blank, it means the customer already has a Webhook callback setup. Changing it will impact the customer’s setup. Assuming the Data Push API section is blank, you are safe to enter the Fusion URL callback URL. This URL is obtained from the Fusion Catchpoint setup screen. Install a Fusion Catchpoint connector and the Webhook callback URL will be displayed in the Fusion installation screen.
  • Save the changes to the Data Push API screen.
  • Catchpoint assigns a “Test ID” for each configured check. In Fusion, you will enter the “Test ID” for the alarm you want to make actionable as an Openmix data feed.
  • To see the “Test ID” for the check you are interested in, if you click on the test you created, the ID is displayed

  • The Catchpoint setup is now complete.

Setup in Fusion

You can access Fusion Data Feeds from the left navigation pane, under Openmix. For initial steps please refer to the Fusion Integration Documentation.

When you get to the service-specific configuration dialog box, enter the following:

  • Name: The name given to the data feed. This will default to “Service - Platform Name” if not specified.
  • Platform: The desired platform for the Catchpoint configured check.
  • Alarm API URL: The URL that gets pasted into the CP Data Push API section as discussed above.
  • Test ID: The Catchpoint Test ID as mentioned in the Catchpoint setup.

Once the Fusion Catchpoint installation is complete, it will be listed on the Fusion data feeds home page with a green status and monitoring metrics in the log history.

To edit a Fusion data feed click on the data feed in the list and then click the Edit button. Once you have changed the configuration, click Save. This will bring you back to the data feed list with your changes saved and applied to the data feed.

Catchpoint