DebugBear

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Integration Steps

• Log in to DebugBear
• Open DebugBear and log in using your credentials.
• Access Project Settings
• Click on Project Settings from the main dashboard.
• Navigate to the Integrations section within the project settings.
• Create a New Webhook
• Scroll down to locate the Create Webhook option.
• Click on Create Webhook.
• Configure the Webhook
• Enter a descriptive name (e.g., "Callgoose SQIBS Integration").
• Paste the endpoint URL provided by Callgoose SQIBS into the webhook URL field. For more details click here.
• Configure the status filter and test type settings to tailor which alerts should trigger notifications.
• Click Save to confirm and complete the webhook setup.
• Set Up Page Monitoring
• Once the webhook is configured, return to the DebugBear dashboard.
• Click on Add Page to create a new monitoring page.
• Configure the page settings (URL, test frequency, performance parameters, etc.) as required.
• After the page is set up, DebugBear will continuously monitor it.
• If any alert is triggered (due to status changes or issues based on your configuration), DebugBear will send an event notification to Callgoose SQIBS via the configured webhook.

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

4.1.1 Example JSON Payloads from DebugBear

Alert Triggered (status: "failure")

json

{
	"page":{
		"id":"381109",
		"url":"https://www.httpbin.org",
		"name":"Httpbin",
		"tags":[
			
		],
		"device":{
			"id":"275857",
			"rtt":40,
			"name":"Desktop",
			"formFactor":"desktop",
			"bandwidthKbps":8192,
			"cpuThrottling":1
		},
		"region":"us-east",
		"formFactor":"desktop",
		"testSchedules":[
			{
				"id":"264283",
				"name":"Every hour"
			}
		],
		"advancedSettings":[
			
		]
	},
	"event":"testComplete",
	"result":{
		"url":"https://www.debugbear.com/viewResult/****/overview",
		"status":"failure",
		"budgets":[
			
		],
		"metrics":{
			"load":null,
			"nodes":16,
			"jsTime":36.1,
			"cpu.other":34.4,
			"cpu.total":71.7,
			"seo.score":0.82,
			"firstPaint":0,
			"hints.count":0,
			"layoutCount":3,
			"requestTtfb":61,
			"console.logs":0,
			"crux.cls.p75":null,
			"crux.fcp.p75":null,
			"crux.goodAvg":null,
			"crux.inp.p75":null,
			"crux.lcp.p75":null,
			"crux.rtt.p75":null,
			"hints.errors":0,
			"requestCount":2,
			"analysis.date":"2025-02-17T05:41:04.257Z",
			"console.other":0,
			"cpu.parseHTML":0.5,
			"crux.ttfb.p75":null,
			"crux.url.good":null,
			"thirdParty.ms":0,
			"console.errors":0,
			"cpu.styleLayout":0.4,
			"crux.url.cls.ok":null,
			"crux.url.fcp.ok":null,
			"crux.url.inp.ok":null,
			"crux.url.lcp.ok":null,
			"outerHtmlLength":null,
			"pageWeight.ajax":null,
			"pageWeight.font":null,
			"console.messages":0,
			"console.warnings":null,
			"crux.granularity":null,
			"crux.origin.good":null,
			"crux.url.cls.bad":null,
			"crux.url.cls.p75":null,
			"crux.url.fcp.bad":null,
			"crux.url.fcp.p75":null,
			"crux.url.inp.bad":null,
			"crux.url.inp.p75":null,
			"crux.url.lcp.bad":null,
			"crux.url.lcp.p75":null,
			"crux.url.rtt.p75":null,
			"crux.url.ttfb.ok":null,
			"documentDuration":237.5,
			"domContentLoaded":null,
			"jsEventListeners":0,
			"pageWeight.image":null,
			"pageWeight.media":null,
			"pageWeight.other":369,
			"pageWeight.total":497,
			"performance.ttfb":237,
			"recalcStyleCount":3,
			"thirdParty.bytes":0,
			"thirdParty.count":0,
			"visuallyComplete":null,
			"crux.url.cls.good":null,
			"crux.url.fcp.good":null,
			"crux.url.inp.good":null,
			"crux.url.lcp.good":null,
			"crux.url.ttfb.bad":null,
			"crux.url.ttfb.p75":null,
			"pageWeight.script":null,
			"performance.score":null,
			"console.pageerrors":0,
			"crux.origin.cls.ok":null,
			"crux.origin.fcp.ok":null,
			"crux.origin.inp.ok":null,
			"crux.origin.lcp.ok":null,
			"crux.url.ttfb.good":null,
			"accessibility.score":0.42,
			"bestPractices.score":0.89,
			"console.totalErrors":0,
			"crux.origin.cls.bad":null,
			"crux.origin.cls.p75":null,
			"crux.origin.fcp.bad":null,
			"crux.origin.fcp.p75":null,
			"crux.origin.inp.bad":null,
			"crux.origin.inp.p75":null,
			"crux.origin.lcp.bad":null,
			"crux.origin.lcp.p75":null,
			"crux.origin.rtt.p75":null,
			"crux.origin.ttfb.ok":null,
			"pageWeight.document":128,
			"pageWeight.redirect":null,
			"cpu.scriptEvaluation":36,
			"crux.origin.cls.good":null,
			"crux.origin.fcp.good":null,
			"crux.origin.inp.good":null,
			"crux.origin.lcp.good":null,
			"crux.origin.ttfb.bad":null,
			"crux.origin.ttfb.p75":null,
			"cpu.garbageCollection":null,
			"crux.origin.ttfb.good":null,
			"pageWeight.stylesheet":null,
			"cpu.scriptParseCompile":0.1,
			"crux.url.imageTtfb.p75":null,
			"performance.speedIndex":null,
			"performance.interactive":null,
			"cpu.paintCompositeRender":0.3,
			"crux.origin.imageTtfb.p75":null,
			"crux.url.lcpLoadDelay.p75":null,
			"crux.url.lcpRenderDelay.p75":null,
			"crux.origin.lcpLoadDelay.p75":null,
			"crux.url.lcpLoadDuration.p75":null,
			"performance.totalBlockingTime":null,
			"crux.origin.lcpRenderDelay.p75":null,
			"crux.origin.lcpLoadDuration.p75":null,
			"performance.firstContentfulPaint":0,
			"performance.cumulativeLayoutShift":0,
			"performance.largestContentfulPaint":null
		},
		"oneLineSummary":"Test failed"
	},
	"project":{
		"id":"68934",
		"name":"New project"
	},
	"analysis":{
		"id":"****",
		"baseHash":null,
		"isPrimary":true,
		"baseBranch":null,
		"commitHash":null,
		"commitBranch":null
	}
}

Alert Resolved (status: "neutral")

json

{
	"page":{
		"id":"381109",
		"url":"https://www.httpbin.org",
		"name":"Httpbin",
		"tags":[
			
		],
		"device":{
			"id":"275857",
			"rtt":40,
			"name":"Desktop",
			"formFactor":"desktop",
			"bandwidthKbps":8192,
			"cpuThrottling":1
		},
		"region":"us-east",
		"formFactor":"desktop",
		"testSchedules":[
			{
				"id":"264283",
				"name":"Every hour"
			}
		],
		"advancedSettings":[
			
		]
	},
	"event":"testComplete",
	"result":{
		"url":"https://www.debugbear.com/viewResult/****/overview",
		"status":"neutral",
		"budgets":[
			
		],
		"metrics":{
			"load":3037,
			"nodes":719,
			"jsTime":268.2,
			"cpu.other":134.3,
			"cpu.total":468.2,
			"seo.score":0.91,
			"firstPaint":1117,
			"hints.count":0,
			"layoutCount":8,
			"requestTtfb":398,
			"console.logs":0,
			"crux.cls.p75":null,
			"crux.fcp.p75":null,
			"crux.goodAvg":null,
			"crux.inp.p75":null,
			"crux.lcp.p75":null,
			"crux.rtt.p75":null,
			"hints.errors":0,
			"requestCount":12,
			"analysis.date":"2025-02-17T05:46:18.988Z",
			"console.other":0,
			"cpu.parseHTML":9.1,
			"crux.ttfb.p75":null,
			"crux.url.good":null,
			"thirdParty.ms":0,
			"console.errors":0,
			"cpu.styleLayout":45.4,
			"crux.url.cls.ok":null,
			"crux.url.fcp.ok":null,
			"crux.url.inp.ok":null,
			"crux.url.lcp.ok":null,
			"outerHtmlLength":16265,
			"pageWeight.ajax":41215,
			"pageWeight.font":76384,
			"console.messages":0,
			"console.warnings":0,
			"crux.granularity":null,
			"crux.origin.good":null,
			"crux.url.cls.bad":null,
			"crux.url.cls.p75":null,
			"crux.url.fcp.bad":null,
			"crux.url.fcp.p75":null,
			"crux.url.inp.bad":null,
			"crux.url.inp.p75":null,
			"crux.url.lcp.bad":null,
			"crux.url.lcp.p75":null,
			"crux.url.rtt.p75":null,
			"crux.url.ttfb.ok":null,
			"documentDuration":574.1,
			"domContentLoaded":3033,
			"jsEventListeners":43,
			"pageWeight.image":0,
			"pageWeight.media":0,
			"pageWeight.other":22695,
			"pageWeight.total":2264694,
			"performance.ttfb":573,
			"recalcStyleCount":28,
			"thirdParty.bytes":78811,
			"thirdParty.count":1,
			"visuallyComplete":3511,
			"crux.url.cls.good":null,
			"crux.url.fcp.good":null,
			"crux.url.inp.good":null,
			"crux.url.lcp.good":null,
			"crux.url.ttfb.bad":null,
			"crux.url.ttfb.p75":null,
			"pageWeight.script":1957825,
			"performance.score":0.68,
			"console.pageerrors":0,
			"crux.origin.cls.ok":null,
			"crux.origin.fcp.ok":null,
			"crux.origin.inp.ok":null,
			"crux.origin.lcp.ok":null,
			"crux.url.ttfb.good":null,
			"accessibility.score":0.93,
			"bestPractices.score":0.96,
			"console.totalErrors":0,
			"crux.origin.cls.bad":null,
			"crux.origin.cls.p75":null,
			"crux.origin.fcp.bad":null,
			"crux.origin.fcp.p75":null,
			"crux.origin.inp.bad":null,
			"crux.origin.inp.p75":null,
			"crux.origin.lcp.bad":null,
			"crux.origin.lcp.p75":null,
			"crux.origin.rtt.p75":null,
			"crux.origin.ttfb.ok":null,
			"pageWeight.document":9751,
			"pageWeight.redirect":0,
			"cpu.scriptEvaluation":217.2,
			"crux.origin.cls.good":null,
			"crux.origin.fcp.good":null,
			"crux.origin.inp.good":null,
			"crux.origin.lcp.good":null,
			"crux.origin.ttfb.bad":null,
			"crux.origin.ttfb.p75":null,
			"cpu.garbageCollection":6.6,
			"crux.origin.ttfb.good":null,
			"pageWeight.stylesheet":156824,
			"cpu.scriptParseCompile":51,
			"crux.url.imageTtfb.p75":null,
			"performance.speedIndex":2885,
			"performance.interactive":3458,
			"cpu.paintCompositeRender":4.6,
			"crux.origin.imageTtfb.p75":null,
			"crux.url.lcpLoadDelay.p75":null,
			"crux.url.lcpRenderDelay.p75":null,
			"crux.origin.lcpLoadDelay.p75":null,
			"crux.url.lcpLoadDuration.p75":null,
			"performance.totalBlockingTime":124,
			"crux.origin.lcpRenderDelay.p75":null,
			"crux.origin.lcpLoadDuration.p75":null,
			"performance.firstContentfulPaint":1117,
			"performance.cumulativeLayoutShift":0.087,
			"performance.largestContentfulPaint":3519
		},
		"oneLineSummary":"JS +1.87 MB, CSS +153 KB, PF ? ➔ 68, BP +7, A11Y +51, SEO +9, CLS +0.087"
	},
	"project":{
		"id":"68934",
		"name":"New project"
	},
	"analysis":{
		"id":"****",
		"baseHash":null,
		"isPrimary":true,
		"baseBranch":null,
		"commitHash":null,
		"commitBranch":null
	}
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an DebugBear 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: "result"."status"
• Key Value Contains: [failure]
• Map Incident With: "page"."id"
• This corresponds to the unique page id from the DebugBear payload.
• Incident Title From: "page"."name"
• 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 "result"."oneLineSummary" key in the Incident Description From field, the incident description will be the value of the "result"."oneLineSummary" key. In the example JSON payload provided earlier, this would result in a description like "Test failed".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "result"."status"
• Key Value Contains: [neutral]
• Incident Mapped With: "page"."id"
• This ensures the incident tied to the specific page 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 DebugBear.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in DebugBear that causes an alert (e.g., when the website is down).
• 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 DebugBear (e.g., when the website 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.
• DebugBear Permissions: Confirm that the webhook in DebugBear 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 DebugBear 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 DebugBear matches the expected structure.

8. Conclusion

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

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