Atatus

Overview

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

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

2. Debugging and Troubleshooting

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

To configure Atatus to send JSON payloads that match the requirements for Callgoose SQIBS, follow these steps to set up the necessary alert policies, notification channels, and triggers within the Atatus platform.

3.1 Setting Up Webhooks in Atatus

• Log in to Atatus:
• Access the Atatus console using your account credentials.
• Connect Your Project:
• From the homepage, connect your relevant project to Atatus (e.g., a website, application, or infrastructure).
• For more details refer Atatus Quick Start.
• Configure Notification Channels:
• Navigate to Alerting on the homepage.
• Click on Notification Channel.
• Select Create New Notification Channel.
• Set Webhook as the channel type.
• Provide a name for this channel.
• In the URL field, enter the API endpoint URL provided by Callgoose SQIBS. Refer to the Callgoose SQIBS API documentation to ensure the URL format is correct.
• Click Create Channel to save the configuration.

3.2 Setting Up Alert Policy in Atatus

• Create an Alert Policy
• After setting up the notification channel, go to Alert Policies.
• Click on Create New Alert Policy.
• Enter a policy name and define the Incident Preferences.
• Select Webhook as notification channel.
• Click Create Policy.
• Define the Alert Rule:
• On the next screen, choose the relevant Product (e.g., Browser).
• Select the Metric that you want to monitor.
• Choose your Project.
• Define the Threshold for the rule (e.g., response time or error rate).
• Provide a Rule Name and click Create Rule.
• For more details about alert rules and policies, refer to the Atatus Alert Policy Documentation.

3.3 Finalizing and Testing

• Validate the Integration:
• Trigger the condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the trigger 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 Atatus triggers, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Atatus

Alert Triggered (wasResolved: "false")

json

{
  "projectId": "****",
  "message": "This is a forced error to test Atatus monitoring.",
  "errorId": "6703bd645583adbc9c7ff279:5d54bde522ca99c55c35719b3c1a5956",
  "url": "http://localhost:3000/",
  "browser": "Chrome 129.0.0.0",
  "os": "Linux x86_64",
  "user": {
    "hash": "****",
    "id": "****",
    "name": "Anonymous",
    "anonymous": true
  },
  "appVersion": "None",
  "wasResolved": false,
  "timestamp": 1728301619913,
  "tags": null,
  "accountId": "****",
  "projectName": "Test",
  "projectType": "browser",
  "timeStart": "2024-10-07T11%3A41%3A59%2B00%3A00",
  "timeEnd": "2024-10-07T12%3A16%3A59%2B00%3A00",
  "errorUrl": "https://www.atatus.com/accounts/****/browser/****/errors/****:****/details?timeDur=custom&timeStart=2024-10-07T11%3A41%3A59%2B00%3A00&timeEnd=2024-10-07T12%3A16%3A59%2B00%3A00",
  "releaseStage": null,
  "occurredAt": "Mon Oct 07 2024, 11:46 am UTC",
  "userInfo": "Anonymous",
  "atatusSite": "https://www.atatus.com",
  "copyrightYear": 2024
}

Alert Resolved (wasResolved: "true")

json

{
  "projectId": "****",
  "message": "This is a forced error to test Atatus monitoring.",
  "errorId": "6703bd645583adbc9c7ff279:5d54bde522ca99c55c35719b3c1a5956",
  "url": "http://localhost:3000/",
  "browser": "Chrome 129.0.0.0",
  "os": "Linux x86_64",
  "user": {
    "hash": "****",
    "id": "****",
    "name": "Anonymous",
    "anonymous": true
  },
  "appVersion": "None",
  "wasResolved": true,
  "timestamp": 1728302023914,
  "tags": null,
  "accountId": "****",
  "projectName": "Test",
  "projectType": "browser",
  "timeStart": "2024-10-07T11%3A48%3A43%2B00%3A00",
  "timeEnd": "2024-10-07T12%3A23%3A43%2B00%3A00",
  "errorUrl": "https://www.atatus.com/accounts/****/browser/****/errors/****:****/details?timeDur=custom&timeStart=2024-10-07T11%3A48%3A43%2B00%3A00&timeEnd=2024-10-07T12%3A23%3A43%2B00%3A00",
  "releaseStage": null,
  "occurredAt": "Mon Oct 07 2024, 11:53 am UTC",
  "userInfo": "Anonymous",
  "atatusSite": "https://www.atatus.com",
  "copyrightYear": 2024
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Atatus 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: "wasResolved"
• Key Value Contains: [false]
• Map Incident With: "errorId"
• This corresponds to the unique errorid from the Atatus payload.
• Incident Title From: null
• Since the payload lacks a meaningful title, you can use the from parameter in the API endpoint URL to provide one. Refer to the API endpoint documentation for more details.
• 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 "This is a forced error to test Atatus monitoring.".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "wasResolved"
• Key Value Contains: [true]
• Incident Mapped With: "errorId"
• This ensures the incident tied to the specific errorid 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 Atatus.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Atatus that causes an alert (e.g., Manually start an error on a monitored application).
• Verify that an incident is created in Callgoose SQIBS with the correct information, including the incident title, description, and mapped values as defined in the API filters.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Atatus (e.g., Fix the Error on the monitor application), verify that the incident in Callgoose SQIBS is automatically marked as resolved.
• Confirm that the resolution details are accurately reflected in Callgoose SQIBS, with the incident status updated accordingly.

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.
• Atatus Permissions: Confirm that the webhook in Atatus has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created:
• Verify that the webhook URL in Atatus is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Check the API logs in Callgoose SQIBS to ensure that the payload is being received and processed correctly.
• Incident Not Resolved:
• Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by Atatus matches the expected structure.
• Use the debugging feature in Callgoose SQIBS to monitor and troubleshoot the incoming payloads.

8. Conclusion

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

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