Sauce Labs

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Integration Steps

• Log in to Sauce Labs:
• Use your Sauce Labs credentials to sign in.
• Access Integrations:
• Once logged in, click on your account icon (usually found in the top-right corner).
• Select Integrations from the dropdown menu.
• Enable Webhook Integration:
• Find the option labeled Integrate with webhook.
• Click on Enable beside this option.
• Configure Webhook:
• Paste the API Endpoint URL provided by callgoose sqibs into the designated field.
• For more details about the API endpoint, refer to the callgoose sqibs API documentation.
• Select Alert Events:
• Choose the events for which you want to receive alerts.
• This configuration allows you to tailor notifications based on your needs.
• Save Configuration:
• Click on Save to finalize your webhook settings.
• Start Automation:
• Navigate to the Get Started Guide within Sauce Labs.
• Follow the on-screen instructions to set up test automation for your app.
• Receive Build Alerts:
• Once configured, you will receive alerts for all builds based on the events selected during the webhook setup.

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

4.1.1 Example JSON Payloads from Sauce Labs

Alert Triggered (status: "FAILED")

json

{
	"id": "****",
	 "creation_time": "2025-02-21T04:44:17Z",
	 "modification_time": "2025-02-21T04:45:34Z",
	 "owner_id": "e915ce02370e48a79468070cb43861c2",
	 "org_id": "bfb2fbde528a4399b972878ca6ec9498",
	 "team_id": "cebaf8d63843485f8d8676821749553d",
	 "status": "FAILED",
	 "name": "Playwright Saucectl",
	 "tags": [
		"Gitpod",
		 "originURL:https://saucelabstrainin-demojs-c0s1ggrvkx1.ws-us117.gitpod.io",
		 "repo:/workspace/demo-js"
	],
	 "automation_backend": "playwright",
	 "data_type": "vdc",
	 "owner": "oauth-****-18d0e",
	 "passed": 0,
	 "os_name": "macOS",
	 "os_version": "Ventura",
	 "duration_sec": "77",
	 "device": "",
	 "app": "storage:1380d5fa-4a70-4b73-9f35-6c3206ba917c",
	 "error": "",
	 "exception": "",
	 "build": "build-2025-02-21T04:44:14Z",
	 "start_time": "2025-02-21T04:44:17Z",
	 "browser_name": "Chrome",
	 "browser_version": "131.0",
	 "group_id": "881faad21ee14fca81b01567f7b332cf",
	 "visibility": "TEAM",
	 "commit_id": "",
	 "branch_name": "",
	 "team_name": "Default team",
	 "sl_url": "https://app.eu-central-1.saucelabs.com/tests/****"
}

Alert Resolved (status: "PASSED")

json

{
	"id": "****",
	 "creation_time": "2025-02-21T04:40:20Z",
	 "modification_time": "2025-02-21T04:41:06Z",
	 "owner_id": "e915ce02370e48a79468070cb43861c2",
	 "org_id": "bfb2fbde528a4399b972878ca6ec9498",
	 "team_id": "cebaf8d63843485f8d8676821749553d",
	 "status": "PASSED",
	 "name": "Playwright Saucectl",
	 "tags": [
		"Gitpod",
		 "originURL:https://saucelabstrainin-demojs-c0s1ggrvkx1.ws-us117.gitpod.io",
		 "repo:/workspace/demo-js"
	],
	 "automation_backend": "playwright",
	 "data_type": "vdc",
	 "owner": "oauth-****-18d0e",
	 "passed": 1,
	 "os_name": "macOS",
	 "os_version": "Ventura",
	 "duration_sec": "46",
	 "device": "",
	 "app": "storage:bd5acca7-3f05-4bf2-aecf-cd04dbac5f78",
	 "error": "",
	 "exception": "",
	 "build": "build-2025-02-21T04:40:17Z",
	 "start_time": "2025-02-21T04:40:20Z",
	 "browser_name": "Chrome",
	 "browser_version": "131.0",
	 "group_id": "881faad21ee14fca81b01567f7b332cf",
	 "visibility": "TEAM",
	 "commit_id": "",
	 "branch_name": "",
	 "team_name": "Default team",
	 "sl_url": "https://app.eu-central-1.saucelabs.com/tests/****"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Sauce Labs 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: "name"
• This corresponds to the unique name from the Sauce Labs payload.
• Incident Title From: "alert"."type"
• 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: "status"
• Key Value Contains: [PASSED]
• Incident Mapped With: "name"
• This ensures the incident tied to the specific name 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 Sauce Labs.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Sauce Labs that causes an alert (e.g., when the test automation fails).
• 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 Sauce Labs (e.g., When test automation runs successfully), 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.
• Sauce Labs Permissions: Confirm that the webhook in Sauce Labs 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 Sauce Labs 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 Sauce Labs matches the expected structure.

8. Conclusion

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

• Sauce Labs 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 Sauce Labs.