Spectate

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Set Up Webhook in Spectate

• Log in to Spectate
• Use your Spectate credentials to log in to the platform.
• Navigate to Integrations
• Click on the Integrations option in the dashboard.
• Install Webhook
• Locate the Webhook option and click on the Install button beside it.
• Configure Webhook Details
• Label: Provide a label for the webhook (e.g., Callgoose SQIBS Alerts).
• Webhook URL: Paste the API endpoint URL provided by Callgoose SQIBS.
• Note: The final API endpoint may vary based on authentication and other URL parameters. Find your API endpoint in the Callgoose SQIBS API Documentation.
• Add Header
• Key: Content-Type
• Value: application/json
• Ensure the status is set to Enabled.
• Save Webhook: Click on Save to save the webhook configuration.

3.2 Add the Webhook as an Alert Destination

• Go to Projects: Navigate to the Projects section in Spectate.
• Select Default Project:
• Click on the Default Project or create a new project as needed.
• Configure Alert Policies:
• Under Alert Policies, click on Add Destination.
• In the Select Destination dropdown, choose the webhook you just created.
• Select Severities: Choose the severities you want to receive alerts for from the dropdown (e.g., Critical).
• Click on Save.
• Note: Instead of using the default project, you can create a new project and define custom alert policies.

3.3 Set Up and Configure Monitors

• Add Monitor
• Navigate to the Monitors section in Spectate.
• Click on Add Monitor.
• Configure the basic details of the monitor based on your requirements.
• Click on Create Monitor.
• Customize Monitor Settings
• Select the newly created monitor.
• Click on Settings.
• Adjust the advanced monitor configurations as needed.
• Resume the monitor.

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

4.1.1 Example JSON Payloads from Spectate

Alert Triggered (status: "failed")

json

{
  "status": "failed",
  "monitor": {
    "id": "9dd0a0df-b76b-46b3-9da6-afc3b512da76",
    "label": "Mgu"
  },
  "response_time": 7693.757,
  "check": "performance-hard-threshold",
  "incident": {
    "id": "c542efdb-b5dd-4ada-958b-c2cb80e28905",
    "started_at": "2024-12-26 11:48:01",
    "resolved_at": null,
    "severity": "medium",
    "cause": "Hard threshold of 500ms exceeded. Response time: 7693.757ms."
  }
}

Alert Resolved (status: "recovered")

{
  "status": "recovered",
  "monitor": {
    "id": "9dd0a0df-b76b-46b3-9da6-afc3b512da76",
    "label": "Mgu"
  },
  "response_time": "7278.457",
  "check": "performance-hard-threshold",
  "incident": {
    "id": "c542efdb-b5dd-4ada-958b-c2cb80e28905",
    "started_at": "2024-12-26 11:48:01",
    "resolved_at": "2024-12-26 12:13:00",
    "severity": "medium",
    "cause": "Hard threshold of 500ms exceeded. Response time: 7693.757ms."
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Spectate 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: "status"
• Key Value Contains: [failed]
• Map Incident With: "incident"."id"
• This corresponds to the unique incident id from the Spectate payload.
• Incident Title From: "check"
• 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 "incident"."cause" key in the Incident Description From field, the incident description will be the value of the "incident"."cause" key. In the example JSON payload provided earlier, this would result in a description like "Hard threshold of 500ms exceeded. Response time: 7693.757ms.".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [recovered]
• Incident Mapped With: "incident"."id"
• This ensures the incident tied to the specific incident id 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 Spectate.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Spectate that causes an alert (e.g., when the page load time exceeds 1000ms. on a monitored server).
• 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 Spectate (e.g., when the page load time returns to a normal level), 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.
• Spectate Permissions: Confirm that the webhook in Spectate 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 Spectate 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 Spectate matches the expected structure.

8. Conclusion

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

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