SpeedCurve

Overview

This document provides a detailed guide to integrating SpeedCurve with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on alerts triggered in SpeedCurve. The guide includes steps for setting up alerts in SpeedCurve, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• SpeedCurve Account: Access to SpeedCurve for creating alerts and managing notifications.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from SpeedCurve.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

• Generate an API Token:
• Follow the guide on How to Create API Token in Callgoose SQIBS.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from SpeedCurve will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with SpeedCurve notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring SpeedCurve to Send JSON Payloads

Follow these steps to set up monitoring, alerts, and webhook integrations in SpeedCurve, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Setting Up Webhook in SpeedCurve

• Log in to SpeedCurve
• Navigate to SpeedCurve and log in using your credentials.
• If you are a new user, follow the on-screen instructions to connect your website to SpeedCurve.
• Configure Webhook in SpeedCurve
• Access Settings:
• Click on the Settings option in SpeedCurve.
• Add Webhook:
• Scroll down to the Alerts section.
• Click on Add Webhook.
• Set Webhook URL:
• Paste the Endpoint URL obtained from Callgoose SQIBS into the Webhook URL field.
• The final API end point may be vary based on authentication and other url parameters. Find your final API End Point here.
• Test Webhook:
• Click on Test Webhook to verify the connection.
• Check the API Log in Callgoose SQIBS to confirm that the payload has been successfully received.
• Save Webhook:
• After verifying the connection, click on Add to save the webhook.

3.2 Set Up Performance Budgets in SpeedCurve

Ensure that your website is properly connected to SpeedCurve. Alerts and performance monitoring require a connected website.

• Access Performance Budgets:
• Click on the Favourites tab.
• Select Performance Budgets.
• Edit or Create Charts:
• To edit an existing chart, click on the chart and modify its settings.
• To create a new chart:
• Click on Add Chart.
• Configure the chart's Type, Data Source, and Data Filter according to your requirements.
• Set Performance Budget:
• Click on Set a Performance Budget.
• Choose the following:
• Budget Metric: Select the metric you want to monitor.
• Threshold: Define the acceptable performance limit.
• Rate of Change Threshold: Specify the change threshold.
• Ensure that the option Send alerts when this threshold is crossed is selected.
• Save Changes:
• Click on Save to finalize the budget.

3.3 Finalizing and Testing

• Validate the Integration:
• Trigger the alert condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the alert to ensure the resolved state payload is also correctly sent and processed.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the SpeedCurve alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from SpeedCurve

Alert Triggered (message_type: "INFO")

json

{
  "chart": {
    "title": "Page Load | AVG",
    "chart_type": "timeseries",
    "metric": [
      "SYN|dom"
    ],
    "listfilter": null,
    "correlation_metrics": [],
    "correlation_stat": "50",
    "stat": "average",
    "site_ids": [
      "all"
    ],
    "snapshot_ids": [],
    "label": [
      "all"
    ],
    "region": [
      "all"
    ],
    "hostname": [
      "all"
    ],
    "pathname": [
      "all"
    ],
    "con": [
      "all"
    ],
    "test_profile_name": [
      "all"
    ],
    "customer_data": [],
    "metric_bounds": [],
    "session_events": [],
    "page_attributes": [],
    "navigation_types": [],
    "delivery_types": []
  },
  "budget": {
    "metric": "Page Load",
    "threshold": "4 seconds",
    "threshold_absolute": 4,
    "threshold_relative": null
  },
  "largest_crossing": {
    "type": "over",
    "threshold": 4,
    "threshold_type": "absolute",
    "threshold_lower": null,
    "threshold_upper": null,
    "difference_from_threshold": 6.06,
    "latest_value": "28.24",
    "series": {
      "name": "Page Load (Syn)",
      "metric": "dom",
      "metrictype": "time",
      "metricName": "Page Load",
      "metricQualified": "SYN|dom",
      "data": [
        {
          "x": 1732072209000,
          "y": "8.16",
          "num": 6,
          "test_id": 500670252,
          "deploy_ids": [
            "3635050"
          ]
        },
        {
          "x": 1732072227000,
          "y": "10.54",
          "num": 12,
          "test_id": 500670280,
          "deploy_ids": [
            "3635052",
            "3635053"
          ]
        },
        {
          "x": 1732072591000,
          "y": "54.62",
          "num": 6,
          "test_id": 500670336,
          "deploy_ids": [
            "3635054"
          ]
        },
        {
          "x": 1732072932000,
          "y": "0.92",
          "num": 1,
          "test": "241120_92_7de26be407297f004afd154a249d7168",
          "test_id": 500670338,
          "deploy_ids": [
            "3635056"
          ]
        },
        {
          "x": 1732073331000,
          "y": "8.74",
          "num": 6,
          "test_id": 500670356,
          "deploy_ids": [
            "3635057"
          ]
        },
        {
          "x": 1732074163000,
          "y": "30.18",
          "num": 12,
          "test_id": 500670790,
          "deploy_ids": [
            "3635063",
            "3635064"
          ]
        },
        {
          "x": 1732074574000,
          "y": "31.84",
          "num": 12,
          "test_id": 500670811,
          "deploy_ids": [
            "3635066",
            "3635067"
          ]
        },
        {
          "x": 1732074999000,
          "y": "28.24",
          "num": 12,
          "test_id": 500670826,
          "deploy_ids": [
            "3635068",
            "3635069"
          ]
        }
      ]
    }
  },
  "crossings": [
    {
      "type": "over",
      "threshold": 4,
      "threshold_type": "absolute",
      "threshold_lower": null,
      "threshold_upper": null,
      "difference_from_threshold": 6.06,
      "latest_value": "28.24",
      "series": {
        "name": "Page Load (Syn)",
        "metric": "dom",
        "metrictype": "time",
        "metricName": "Page Load",
        "metricQualified": "SYN|dom",
        "data": [
          {
            "x": 1732072209000,
            "y": "8.16",
            "num": 6,
            "test_id": 500670252,
            "deploy_ids": [
              "3635050"
            ]
          },
          {
            "x": 1732072227000,
            "y": "10.54",
            "num": 12,
            "test_id": 500670280,
            "deploy_ids": [
              "3635052",
              "3635053"
            ]
          },
          {
            "x": 1732072591000,
            "y": "54.62",
            "num": 6,
            "test_id": 500670336,
            "deploy_ids": [
              "3635054"
            ]
          },
          {
            "x": 1732072932000,
            "y": "0.92",
            "num": 1,
            "test": "241120_92_7de26be407297f004afd154a249d7168",
            "test_id": 500670338,
            "deploy_ids": [
              "3635056"
            ]
          },
          {
            "x": 1732073331000,
            "y": "8.74",
            "num": 6,
            "test_id": 500670356,
            "deploy_ids": [
              "3635057"
            ]
          },
          {
            "x": 1732074163000,
            "y": "30.18",
            "num": 12,
            "test_id": 500670790,
            "deploy_ids": [
              "3635063",
              "3635064"
            ]
          },
          {
            "x": 1732074574000,
            "y": "31.84",
            "num": 12,
            "test_id": 500670811,
            "deploy_ids": [
              "3635066",
              "3635067"
            ]
          },
          {
            "x": 1732074999000,
            "y": "28.24",
            "num": 12,
            "test_id": 500670826,
            "deploy_ids": [
              "3635068",
              "3635069"
            ]
          }
        ]
      }
    }
  ],
  "chart_image_url": "https://alerts.speedcurve.com/image/alert/36770ee394e9d0e947d95095964e150e6ec6dcd1cc52d5e011d7e173f17811d9",
  "chart_web_url": "https://speedcurve.com/mgu/favorite/?d=7&db=925902&de=1&ds=1#chart_1985414_wrapper",
  "message_type": "INFO"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an SpeedCurve integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "message_type"
• Key Value Contains: [INFO]
• Map Incident With: null
• Incident Title From: "chart"."title"
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Incident Mapped With: null

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by SpeedCurve.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in SpeedCurve that causes an alert (e.g., when the page load time exceeds 1000ms. on a monitored website).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
• SpeedCurve Permissions: Confirm that the webhook in SpeedCurve has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in SpeedCurve is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by SpeedCurve matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate SpeedCurve with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from SpeedCurve are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both SpeedCurve and Callgoose SQIBS:

• SpeedCurve Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time alerts from SpeedCurve.