TrackJS

Overview

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

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

2. Debugging and Troubleshooting

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

To configure TrackJS to generate the JSON payloads similar to the examples provided, follow the steps outlined below. These steps will guide you through setting up the necessary alerts and webhook notifications within TrackJS to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Monitor in TrackJS

To generate the required JSON payloads, you first need to set up alerts within TrackJS.

• Log in to the TrackJS Console:
• Access the TrackJS platform using your account credentials.
• Connect Your Application to TrackJS
• Follow the on-screen instructions provided after login to integrate your application with the TrackJS SDK.
• Include the SDK in your application's codebase as instructed.
• Once connected, TrackJS will begin tracking errors in your application.

3.2 Configuring the Webhook Notification

• Set Up Webhook Notifications
• Navigate to the Settings tab in TrackJS.
• Click on Notifications.
• Under the Channels section, note that there is no dedicated webhook option.
• Click on Add Teams to create a custom notification channel.
• Provide a name for your notification channel.
• In the Webhook URL field, paste the endpoint URL provided by Callgoose SQIBS.
• Note: The final API endpoint may vary based on authentication requirements and URL parameters.
• Refer to the Callgoose SQIBS API Documentation to find and configure the correct endpoint.
• Click on Save to confirm your webhook setup.
• Assign the created channel to the events for which you want to receive alerts, such as New Error or Error Rate Increases.

3.3 Finalizing and Testing

• Validate the Integration:
• Trigger the condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the TrackJS alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from TrackJS

Alert Triggered (type: "MessageCard")

json

{
	"@type":"MessageCard",
	"@context":"http://schema.org/extensions",
	"themeColor":"eb503e",
	"summary":"TrackJS Notification",
	"sections":[
		{
			"activityTitle":"*New Error*<br>[This is a manually triggered error for testing TrackJS!](https://my.trackjs.com/errors/filtered?hash=***&application=%28Default%29&account=***)",
			"activitySubtitle":"9 minutes ago | 12/03/2024 05:22:23 UTC | 2 times | Chrome | 1 url | Linux Chrome User@****",
			"facts":[
				
			],
			"markdown":true
		},
		{
			"activityTitle":"*New Error*<br>[\\[\"Logging manual error:\",{\"name\":\"Error\",\"message\":\"This is ...](https://my.trackjs.com/errors/filtered?hash=****&application=%28Default%29&account=****)",
			"activitySubtitle":"9 minutes ago | 12/03/2024 05:22:23 UTC | 2 times | Chrome | 1 url | Linux Chrome User@****",
			"facts":[
				
			],
			"markdown":true
		},
		{
			"activityTitle":"*New Error*<br>[\\[\"Caught an error:\",{\"name\":\"ReferenceError\",\"message\":\"nonE...](https://my.trackjs.com/errors/filtered?hash=****&application=%28Default%29&account=****)",
			"activitySubtitle":"9 minutes ago | 12/03/2024 05:22:18 UTC | 2 times | Chrome | 1 url | Linux Chrome User@****",
			"facts":[
				
			],
			"markdown":true
		}
	],
	"potentialAction":[
		{
			"@type":"OpenUri",
			"name":"Mute for 1 hour",
			"targets":[
				{
					"os":"default",
					"uri":"https://my.trackjs.com/account/notifications/mute?token=****&duration=1&from=Teams&account=****"
				}
			]
		},
		{
			"@type":"OpenUri",
			"name":"Mute for 8 hours",
			"targets":[
				{
					"os":"default",
					"uri":"https://my.trackjs.com/account/notifications/mute?token=****&duration=8&from=Teams&account=****"
				}
			]
		},
		{
			"@type":"OpenUri",
			"name":"Mute for 24 hours",
			"targets":[
				{
					"os":"default",
					"uri":"https://my.trackjs.com/account/notifications/mute?token=****&duration=24&from=Teams&account=****"
				}
			]
		}
	]
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a TrackJS 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: "event.description"
• This will use the event description as the incident title in Callgoose SQIBS.
• 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 "sections".[0]."activityTitle" key in the Incident Description From field, the incident description will be the value of the "sections".[0]."activityTitle" key. In the example JSON payload provided earlier, this would result in a description like: "*New Error* [This is a manually triggered error for testing TrackJS!](https://my.trackjs.com/errors/filtered?hash=****&application=%28Default%29&account=****)".
• 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 TrackJS.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in TrackJS that causes an alert (e.g., a spike in error rates in an application).
• Verify that an incident is created in Callgoose SQIBS with the correct information, including the title, description, and urgency level.

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.
• TrackJS Permissions: Confirm that the webhook in TrackJS has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between TrackJS and Callgoose SQIBS is encrypted, especially if sensitive information is involved.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in TrackJS 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 TrackJS matches the expected structure.

8. Conclusion

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

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