Tesults

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Project in Tesults

• Log in to Tesults:
• Access Tesults and log in using your credentials.
• Create a Project in Tesults (if not already created):
• After logging in, create your project by following the prompts. This project will act as the repository for your test results and data.
• Connect Your Code to Tesults:
• Once the project is created, Tesults provides specific integration instructions. Follow the on-screen steps to link your code to Tesults.
• This connection enables your project to send data from your test suite to Tesults.

3.2 Setting Up Webhook in Tesults

• Configure Tesults Integration:
• In Tesults, navigate to Settings > Configuration > Integrations.
• Select Webhooks (MS Teams, Mattermost) as the integration option.
• Add Callgoose SQIBS Webhook in Tesults:
• Since there is no dedicated webhook field, choose Add a webhook under the MS Teams section.
• Paste the Callgoose SQIBS endpoint URL in this field.
• The final API endpoint for Callgoose SQIBS may vary based on authentication or specific parameters.
• Find the endpoint details in your Callgoose SQIBS dashboard here.
• Save Changes:
• Once the webhook URL is pasted, click Save Changes to apply the integration settings.

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

4.1.1 Example JSON Payloads from Tesults

Alert Triggered (@type: "MessageCard")

json

{
  "@type": "MessageCard",
  "@context": "http://schema.org/extensions",
  "themeColor": "#f0ad4e",
  "title": "Default",
  "text": "66.67% Pass (2/3)\n\nTest",
  "potentialAction": [
    {
      "@context": "http://schema.org",
      "@type": "ViewAction",
      "name": "Results",
      "target": [
        "https://www.tesults.com/results/rsp/view/results/run/****"
      ]
    },
    {
      "@context": "http://schema.org",
      "@type": "ViewAction",
      "name": "Smart Analysis",
      "target": [
        "https://www.tesults.com/results/rsp/view/supplemental/run/****"
      ]
    },
    {
      "@context": "http://schema.org",
      "@type": "ViewAction",
      "name": "Dashboard",
      "target": [
        "https://www.tesults.com/results/rsp/view/status/****"
      ]
    }
  ]
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Tesults 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: "@type"
• Key Value Contains: [MessageCard]
• Map Incident With: null
• Incident Title From: "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 "66.67% Pass (2/3)\n\nTest.".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Incident Mapped With: null

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 Tesults

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Tesults that causes an alert (e.g., when an error occurs while testing any code).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

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

8. Conclusion

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

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