Status Page Metrics Integration

  • 2 minute(s) read
Prev Next

Introduction

Statuspage is the one of the top status and incident communication tool, and helps keep customers and employees informed during downtime to build trust and cut support costs. It supports collecting and reporting on performance metrics metrics to show performance trends over time, which is a great way to build trust and transparency around your organization and ensure that your page is doing work for you each day. This integration enables you to submit performance data from Catchpoint into Statuspage.

Prerequisites

  1. Statuspage admin account.
  2. Catchpoint test with Test Data Webhook enabled.

Installation & Configuration

Configuration in Statuspage – Create Metric:

  1. Log in to Statuspage.
  2. Click on Your page.
  3. Click on System metrics.
  4. Click Add a metric to create a new one.
  5. Choose Data source as I’ll submit my own data from this metric.
  6. Enter the metric name as Display name.
  7. Input the appropriate type of units in the Display Suffix field (e.g. ms, bytes, score).
    mceclip0.png
  8. Click Add metrics to save the changes.
  9. Statuspage displays a script you can use to make a POST request submitting data for the newly created metric. Make a note of this script; it contains your page_id and metric_id, which you will use to post data from Catchpoint.

Configuration in Statuspage – Create API Key:

  1. In Statuspage, click on your profile icon at the lower left of the screen.
  2. Click on API info.
  3. If you don’t have an API key already created, then click on Create key.
  4. Provide an API key name.
  5. Click Confirm.
  6. Copy the API key so that we can use it to configure in Catchpoint portal.

Configuration in Catchpoint Portal – Test Data Webhook:

  1. Log in the Catchpoint Portal, then go to Settings > API.
  2. Click Add URL.
  3. Enter a Name.
  4. Enter URL, the endpoint where the alert data will be posted, using the following syntax (replace <page_id> and <metric_id> with the values captured from Statuspage):
    https://api.statuspage.io/v1/pages/<page_id>/metrics/<metric_id>/data.json
  5. Select Template under Format.
  6. Click Add New, to create a new template.
  7. Enter a template Name.
  8. Paste the below sample template:
{
    "data":
        {
            "timestamp": ${TimestAmpEpoch},
            "value": ${TimingVisuallyCompleteTime}
        }
}
  1. Click Save.
  2. Select the newly created template.
  3. Add an email address to On Failure Alert.
  4. Expand Request.
  5. Click Add API Request Headers.
  6. Add Header field with a key of “Authorization” and value of “OAuth <Statuspage_API_Key>” (replacing <statuspage_API_Key> with the key value captured from Statuspage).
  7. Click Save.

Note:

  • The Test Data Webhook option must be enabled in the properties of each test that you want to send metrics to Statuspage.
  • Once the metric value is sent to Statuspage, set the metrics status as active.
  • Based on the use case, use choose the metric macro that meets your requirement.
  • One metric can be sent at a time.

Results

Metrics in Statuspage can be viewed in the metrics panel.

mceclip1.png