Honeybadger

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Honeybadger

• Login to Honeybadger
• Go to Honeybadger's login page and log in with your credentials.
• Create a Project
• If you don’t already have a project:
• Click on New Project from the dashboard.
• Follow the prompts to name and set up your project.
• If you already have a project, proceed to the next step.
• Connect Honeybadger's Client Library
• Follow the instructions in the Honeybadger documentation to install and configure the client library for your specific language or framework (e.g., Ruby, Python, Node.js).
• Navigate to Project Settings
• Once your project is set up and the client library is connected, go to the project dashboard.
• Click on Settings at the top or side of the page.

3.2 Setting Up Webhook Integration for Alerts

• Go to Alerts & Integrations
• From the project settings menu, click on Alerts & Integrations.
• Configure Webhook Integration
• In the Alerts & Integrations section, scroll through the list of available integrations and click on Webhook.
• Enter the Callgoose SQIBS API URL
• In the Webhook URL field, enter the API endpoint URL provided by Callgoose SQIBS.
• Choose Events to Receive
• Select which events (e.g., When an error is initially reported) you want to send to Callgoose SQIBS.
• Test the Integration
• Click on Test this Integration to verify the connection.
• A test payload can be viewed from API log section of callgoose SQIBS if the connection is configured correctly.
• Save Changes
• Once the test is successful, click Save Changes to complete the integration.

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

4.1.1 Example JSON Payloads from Honeybadger

Alert Triggered (event: "occurred")

json

{
  "event": "occurred",
  "message": "[imperative-buffalo/production] Error: Testing Honeybadger!",
  "project": {
    "id": 127974,
    "name": "imperative-buffalo",
    "created_at": "2024-10-16T08:53:31.301293Z",
    "disable_public_links": false,
    "pivotal_project_id": null,
    "asana_workspace_id": null,
    "token": "****",
    "github_project": null,
    "environments": [
      {
        "id": 275867,
        "project_id": 127974,
        "name": "production",
        "notifications": true,
        "created_at": "2024-10-16T08:59:37.796875Z",
        "updated_at": "2024-10-16T08:59:37.796875Z"
      }
    ],
    "owner": {
      "id": 122995,
      "email": "****@nbmbb.com",
      "name": "****"
    },
    "last_notice_at": "2024-10-16T08:59:37.000000Z",
    "earliest_notice_at": "2024-07-18T08:59:38.181998Z",
    "unresolved_fault_count": 0,
    "fault_count": 0,
    "active": true,
    "users": [
      {
        "id": ****,
        "email": "****@nbmbb.com",
        "name": "****"
      }
    ],
    "sites": [],
    "team_id": 43314
  },
  "fault": {
    "project_id": 127974,
    "klass": "Error",
    "component": null,
    "action": null,
    "environment": "production",
    "resolved": false,
    "ignored": false,
    "created_at": "2024-10-16T08:59:37.772763Z",
    "project_name": "imperative-buffalo",
    "comments_count": 0,
    "message": "Testing Honeybadger!",
    "notices_count": 1,
    "last_notice_at": "2024-10-16T08:59:37.765286Z",
    "tags": [],
    "id": ****,
    "assignee": null,
    "url": "https://app.honeybadger.io/projects/****/faults/****",
    "deploy": null
  },
  "notice": {
    "id": ****,
    "environment": {},
    "created_at": "2024-10-16T08:59:37.016083Z",
    "message": null,
    "token": "c778ea35-b306-411f-af43-a503b1442d3e",
    "fault_id": 113660205,
    "request": {
      "url": "https://kaleidoscopic-fox-cec389.netlify.app/",
      "params": {},
      "session": {}
    },
    "backtrace": [
      {
        "file": "https://kaleidoscopic-fox-cec389.netlify.app/",
        "method": "testHoneybadger",
        "number": 20,
        "column": 19,
        "context": "all"
      },
      {
        "file": "https://kaleidoscopic-fox-cec389.netlify.app/",
        "method": "HTMLButtonElement.onclick",
        "number": 27,
        "column": 39,
        "context": "all"
      }
    ],
    "application_trace": [],
    "web_environment": {
      "HTTP_USER_AGENT": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36"
    },
    "deploy": null,
    "url": "https://app.honeybadger.io/projects/127974/faults/****/****"
  },
  "context": {}
}

Alert Resolved (event: "resolved")

json

{
  "event": "resolved",
  "message": "[imperative-buffalo/production] Error resolved by Robert D",
  "actor": {
    "id": ****,
    "email": "****@nbmbb.com",
    "name": "****"
  },
  "fault": {
    "project_id": 127974,
    "klass": "Error",
    "component": null,
    "action": null,
    "environment": "production",
    "resolved": true,
    "ignored": false,
    "created_at": "2024-10-16T08:59:37.772763Z",
    "project_name": "imperative-buffalo",
    "comments_count": 1,
    "message": "Testing Honeybadger!",
    "notices_count": 1,
    "last_notice_at": "2024-10-16T08:59:37.765286Z",
    "tags": [],
    "id": ****,
    "assignee": null,
    "url": "https://app.honeybadger.io/projects/127974/faults/****",
    "deploy": null
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Honeybadger 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: "event"
• Key Value Contains: [occurred]
• Map Incident With: "fault"."project_id"
• This corresponds to the unique fault.project_id from the Honeybadger payload.
• Incident Title From: "project"."name"
• 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.
• Example: If you use the "message" key in the Incident Description From field, the incident description will be the value of the "message" key. In the example JSON payload provided earlier, this would result in a description like "[imperative-buffalo/production] Error resolved by Robert D".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "event"
• Key Value Contains: [resolved]
• Incident Mapped With: "fault"."project_id"
• This ensures the incident tied to the specific incident.key is resolved when the alert status returns to normal.

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 Honeybadger.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Honeybadger that causes an alert (e.g., Trigger a JavaScript error in your web app).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Honeybadger (e.g., Fix the JavaScript error), verify that the incident in Callgoose SQIBS is automatically marked as resolved.

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.
• Honeybadger Permissions: Confirm that the webhook in Honeybadger 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 Honeybadger 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 Honeybadger matches the expected structure.

8. Conclusion

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

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