Tideways

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Tideways

• Login to Tideways
• Open the Tideways application and log in to your account.
• Create an Organization
• If this is your first time using Tideways, create an organization.
• Follow any additional instructions provided in the Setting up a Tideways Account documentation to complete the setup.
• Create a Project
• After creating your organization, create a new project in Tideways. This project represents your application and will allow data to flow from your application to Tideways.
• After creating the project, a new Setup page will appear with detailed instructions on connecting your application to Tideways for data transfer.
• Connect Your Application to Tideways
• Follow the instructions on the Setup page to establish the connection.
• Once connected, Tideways will begin receiving performance data from your application.

3.2 Setting Up Webhook in Tideways

• Navigate to Notifications
• In Tideways, go to the Notifications section.
• Manage Integrations
• Click on Manage Integrations in the Notifications section.
• Add New Integration
• Click on Add New Integration.
• Select Webhook as the integration type.
• Configure Webhook Integration
• Name: Give your webhook integration a meaningful name.
• Webhook URL: In the Webhook URL field, paste the endpoint URL provided by Callgoose Sqibs. The final API end point may be vary based on authentication and other url parameters. Find your final API End Point here.
• Ensure that the “And when the alert is fixed” option is checked so notifications are sent when an alert is resolved.
• Create Integration
• After configuring the webhook, click Create to complete the integration setup.
• Test Payload
• In Tideways, click on Preview within the webhook settings to send a test payload to Callgoose Sqibs.
• Verify in Callgoose Sqibs
• Go to API Logs in Callgoose Sqibs to confirm that the test payload has been received.

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

4.1.1 Example JSON Payloads from Tideways

Alert Triggered (status: "opened")

json

{
  "type": "response_time",
  "link": "https://app.tideways.io/o/Zenox/Test/issues/incident?error=*****&env=production&s=app&source=webhook",
  "organization": "Zenox",
  "application": "Test",
  "date": "2024-10-24 15:55",
  "notification": {
    "incidient_id": ****,
    "incident_id": ****,
    "status": "opened",
    "value": 1234,
    "criticalThreshold": 1000
  }
}

Alert Resolved (status: "closed")

json

{
  "type": "response_time",
  "link": "https://app.tideways.io/o/Zenox/Test/issues/incident?error=1729785655&env=production&s=app&source=webhook",
  "organization": "Zenox",
  "application": "Test",
  "date": "2024-10-24 15:55",
  "notification": {
    "incidient_id": 1729785655,
    "incident_id": 1729785655,
    "status": "closed",
    "value": 100,
    "criticalThreshold": 1000
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Tideways 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: "notification"."status"
• Key Value Contains: [opened]
• Map Incident With: "notification"."incident_id"
• This corresponds to the unique notification incident_id from the Tideways payload.
• Incident Title From: "application"
• 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: "notification"."status"
• Key Value Contains: [closed]
• Incident Mapped With: "notification"."incident_id"
• This ensures the incident tied to the specific notification 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 Tideways.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Tideways that causes an alert (e.g., you could create an application error or intentionally trigger an exception that Tideways is configured to monitor).
• 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 Tideways (e.g., Fix the 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.
• Tideways Permissions: Confirm that the webhook in Tideways 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 Tideways 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 Tideways matches the expected structure.

8. Conclusion

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

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