RootCause

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Configure the Integration in RootCause

• Log In to RootCause:
• Access the RootCause platform and log in using your credentials.
• Navigate to Organization Settings:
• Once logged in, click on the Organization Settings.
• Access the Integrations Section:
• In the Integrations section, there is no specific webhook field. Instead, click on the Slack integration option.
• Set Up the Integration:
• Provide a Name for the integration (e.g., "Callgoose").
• Paste the API Endpoint URL provided by Callgoose SQIBS into the relevant field.
• The final API end point may be vary based on authentication and other url parameters. Find your final API End Point here.
• Test the Connection:
• Click on the Test button to verify the connection.
• If the connection is successful, a payload will be visible in the API Log section of the Callgoose SQIBS platform.
• Save Changes:
• Click Save Changes to finalize the integration configuration.

3.2 Add and Configure an Application in RootCause

• Go to Applications Section:
• In RootCause, navigate to the Applications section.
• Add a New Application:
• Click on Add Application.
• Provide a Name for the application (e.g., "My App").
• Configure the Application:
• After creating the application, click on Settings for the newly created application.
• In the settings, you will find Configuration Options and On-Screen Instructions to connect the application to your app.

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

4.1.1 Example JSON Payloads from RootCause

Alert Triggered (color: "danger")

json

{
  "text": "[My First Application] [1] helloWorld is not defined",
  "attachments": [
    {
      "color": "danger",
      "title": "helloWorld is not defined",
      "title_link": "https://app.therootcause.io/#zeronx/my-first-application/errors/****"
    }
  ],
  "username": "Callgoose"
}

Alert Resolved (text: "Fixed")

json

{
  "text": "Error Fixed : helloWorld is not defined",
  "attachments": [
    {
      "title": "helloWorld is not defined",
      "text": "*Robin* marked issue as *Fixed*",
      "title_link": "https://app.therootcause.io/#zeronx/my-first-application/errors/****",
      "mrkdwn_in": [
        "text"
      ]
    }
  ],
  "username": "Callgoose"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an RootCause 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: "attachments".[0]."color"
• Key Value Contains: [danger]
• Map Incident With: "attachments".[0]."title_link"
• This corresponds to the unique title_link from the RootCause payload.
• Incident Title From: "attachments".[0]."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.
• Example: If you use the "text" key in the Incident Description From field, the incident description will be the value of the "text" key. In the example JSON payload provided earlier, this would result in a description like "[My First Application] [1] helloWorld is not defined".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "text"
• Key Value Contains: [Fixed]
• Incident Mapped With: "attachments".[0]."title_link"
• This ensures the incident tied to the specific title_link 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 RootCause.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in RootCause that causes an alert (e.g., Manually Generate an Error.).
• 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 RootCause (e.g., Mark the error as Resolved in RootCause), 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.
• RootCause Permissions: Confirm that the webhook in RootCause 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 RootCause 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 RootCause matches the expected structure.

8. Conclusion

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

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