HyperDX

Overview

This document provides a detailed guide to integrating HyperDX 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 HyperDX. The guide includes steps for setting up alerts in HyperDX, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• HyperDX Account: Access to HyperDX 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 HyperDX.

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 HyperDX will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with HyperDX 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 HyperDX to Send JSON Payloads

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

3.1 Setting Up Webhook in HyperDX

• Log in to Hyperdx
• Begin by logging into your Hyperdx account.
• Connect Your Technology Stack with Hyperdx
• Follow the on-screen instructions on Hyperdx to connect your desired technology stack or application to Hyperdx.
• Create a Generic Webhook
• After successfully connecting, navigate to Team Settings:
• Scroll down to the Generic Incoming Webhook section.
• Click on Add Generic Incoming Webhook.
• Configure Webhook Settings:
• Webhook Name: Enter a descriptive name for the webhook.
• Webhook URL: In this field, paste the endpoint URL provided by Callgoose SQIBS.
• Description (Optional): Provide a description to specify the purpose or usage of this webhook.
• In the Custom Body field, paste the following JSON configuration:

{
    "body": "{{body}}",
    "title": "{{title}}",
    "link": "{{link}}"
}

• Save the Webhook:
• Click on Add to save this webhook configuration.
• Configure Alert for Webhook
• Go to the Hyperdx homepage by clicking the Hyperdx icon.
• From the homepage, click on Alert (located next to the Save icon on the dashboard).
• Set Up Alert:
• Configure the alert event according to your requirements.
• Send Alert via Webhook:
• In the Via field, select Webhook.
• In the Send Alert To field, choose the webhook you created in the previous steps.
• Click on save.

3.2 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 HyperDX alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from HyperDX

Alert Triggered (title: "Alert")

json

{
"body": "\n10 lines found, expected less than 1 lines\n\n```\nNov 11 05:03:34Z [info] 127.0.0.1 - - [11/Nov/2024 10:33:34] \"GET /trace HTTP/1.1\" 200 -\nNov 11 05:03:33Z [info] 127.0.0.1 - - [11/Nov/2024 10:33:33] \"GET /trace HTTP/1.1\" 200 -\nNov 11 05:03:32Z [info] 127.0.0.1 - - [11/Nov/2024 10:33:32] \"GET /trace HTTP/1.1\" 200 -\nNov 11 05:03:31Z [info] 127.0.0.1 - - [11/Nov/2024 10:33:31] \"GET /trace HTTP/1.1\" 200 -\nNov 11 05:03:29Z [info] 127.0.0.1 - - [11/Nov/2024 10:33:29] \"GET /trace HTTP/1.1\" 200 -\n```", 
"title": "Alert for \"All Events\" - 10 lines found", "link":"https://www.hyperdx.io/search/673190154bb9017c6069fe6e?from=1731301380000&to=1731301440000"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an HyperDX 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: "title"
• Key Value Contains: [Alert]
• Map Incident With: null
• Incident Title From: "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 HyperDX.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in HyperDX that causes an alert (e.g., Intentionally cause a failing event in the connected app).
• 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.
• Uptrends Permissions: Confirm that the webhook in Uptrends 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 HyperDX 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 HyperDX matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate HyperDX with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from HyperDX 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 HyperDX and Callgoose SQIBS:

• HyperDX 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 HyperDX.