F5 Beacon Integration with Catchpoint

Prev Next

Introduction

F5 Beacon provides application visibility and analytics to gain insight into the end-user experience. With this integration, we are expanding on the proactive monitoring checks provided by F5 Beacon by allowing users to set up additional tests in Catchpoint and then view the health of the test in the F5 beacon dashboard. This will enable us to get comprehensive health visibility throughout the application in terms of end-user experience.

Test Webhook Data in Catchpoint is being used to send data to F5 Beacon after each run. Based on the test run success or failure, a status of Available or Failure will be sent to F5 Beacon.

Prerequisites

  • F5 Beacon account

Installation & Configuration

Setup in F5 Beacon Portal

  1. Token Configuration in F5 Beacon portal, step by step instruction here.
  2. Create a Beacon application in the F5 Beacon portal, step by step instruction here.

Note: For this example, you can create a beacon application with just one node, as shown below.

dns_node

Setup in Catchpoint Portal

  1. Set up a DNS test and enable Test Data Webhook under Advanced Settings.
  2. Navigate to the API page under Settings in the main menu.
  3. Set up a Test Data Webhook with the details shown in the screenshot and template below.mceclip0.png - URL: https://ingestion.ovr.prd.f5aas.com:50443/beacon/v1/ingest
  • Use the following JSON structure data when creating the template in Test Data Webhook. Replace <token_here> with your token.
{
	"sourceName": "CP ${TestType} ${TestId}",
	"sourceDescription": "${TestType} test healthStatus",
	"token": "<token_here>",
	"components": [
	    {
	        "name": "${TestType} ${TestId}",
	        "description": " ${TestType} test set up in Catchpoint",
	        "healthStatus": "${switch("${errorany}","False","AVAILABLE","false","AVAILABLE","CRITICAL")}"
	    }
	]
}

Link Catchpoint Data in F5 Beacon Portal

Before you can link the Catchpoint data, you need to confirm that it is available in the F5 Beacon portal by following these steps:

  1. Log into the F5 Beacon portal.
  2. Select Configuration.
  3. Click on Sources.
  4. If the data from Catchpoint is reaching F5 Beacon successfully, then the Test ID from Catchpoint should be displayed as shown in the screenshot below. mceclip0.png

Follow these steps to link the data:

  1. Log in to F5 Beacon portal.
  2. Open the Beacon application from Application Landscape and then List View.
  3. Click on the application name.
  4. Click to enable edit mode.
  5. Select the DNS node you created earlier.
  6. Click on Edit Node from the top menu.
  7. Click on Save and Continue to load Metric Health Condition.
  8. Click on the Add button.
  9. Select Pick a source type and choose beacon-health-source.
  10. Under Select filters, choose a name, and for value input Test ID and select.
  11. Click on Add.
  12. Click on Save.
  13. Last click on Save and Close.

Results

Once linked, it takes about a minute to load the data. Refresh the page to see the change in the List View page.

mceclip1.png

The Health Status will change to indicate a successful data connection.

mceclip2.png

To view the data, click on the heart icon, and a side-panel will open displaying the dashboard.

mceclip4.png