Backtrace

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Webhook in Backtrace

• Log in to Backtrace
• Log in to your Backtrace account using your credentials.
• If you haven’t created a project yet, set one up by following the on-screen instructions.
• Select an existing project, use a demo project, or integrate with your technology stack as required.
• Create a Webhook Integration
• Click on your profile icon and navigate to Project Settings.
• Under the Workflow section, go to Integrations.
• If you haven't already, create a submission token by clicking on Submission Tokens.
• Click on the + icon to generate a new token. This will allow Backtrace to send data to Callgoose SQIBS.
• Return to the Integrations page.
• Click on the + icon and choose Webhook.
• Enter a name for this integration.
• In the Server field, paste the endpoint URL provided by Callgoose SQIBS.
• Click Next.
• Choose the sections of the notification body you want to display, such as Classifiers or Callstack.
• Click Submit to complete the webhook setup.

3.2 Setting Up Alerts in Backtrace

• Configure Alerts
• Under the Workflow section, go to Alerts.
• Select Error Threshold Alerts (or Issue-based Alerts if desired). For this guide, we will use Error Threshold Alerts.
• Click on Create an Alert in Explore.
• Click Add Aggregation and search for the aggregation metric, such as State.
• Select the aggregation operation and click on the Export icon.
• Set Alert and Notification Options
• Choose Alert as the export type and provide a name for the alert.
• Configure the Threshold and Notification Intervals as required.
• In the Integration field, select the webhook you created earlier.
• Click Save to finalize the alert setup.

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

4.1.1 Example JSON Payloads from Backtrace

Alert Triggered (classifier: "alert")

json

{
  "classifier": [
    "alert"
  ],
  "group_url": "https://mexut.sp.backtrace.io/p/Game3/settings/alerts?id=****",
  "project": "Game3",
  "universe": "mexut",
  "timestamp": [
    1730698760133,
    1730698760133
  ],
  "href": "https://mexut.sp.backtrace.io",
  "attributes": {
    "universe": "mexut",
    "project": "Game3",
    "alertName": "Test Alert",
    "alertUrl": "https://mexut.sp.backtrace.io/p/Game3/settings/alerts?id=****",
    "alertCriticalGroupCount": 1,
    "alertCriticalTriggerCount": 1,
    "alertWarningGroupCount": 0,
    "alertWarningTriggerCount": 0
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Backtrace 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: "classifier".[0]
• Key Value Contains: [alert]
• Map Incident With: "incident"."key"
• This corresponds to the unique incident.key from the Backtrace payload.
• Incident Title From: "project"
• 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 Backtrace.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Backtrace that causes an alert (e.g., An error in your connected application).
• 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.
• Backtrace Permissions: Confirm that the webhook in Backtrace 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 Backtrace 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 Backtrace matches the expected structure.

8. Conclusion

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

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