Uptrends

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up a Monitor in Uptrends

• Log in to Uptrends:
• Access the Uptrends platform using your account credentials.
• Create a Monitor:
• From the homepage, click on Create Monitor.
• Choose the monitor type (e.g., Full Page Check) based on the kind of performance or availability metrics you want to track.
• Fill Out Monitor Details:
• Complete the required details in the Main Section such as the monitor name, URL, and interval settings.
• Set Error Conditions:
• In the Error Condition section, define specific error conditions. For example, set a condition to check the page load time and trigger an error if it exceeds 3000ms.
• Additional Configuration:
• Fill in all other details as needed, Refer Uptrends Add Monitor Documentation for guidance on specific configuration options.
• Test the Monitor:
• Click on Test to ensure that the monitor is working as expected and correctly checking the set conditions.
• Save the Monitor:
• Once satisfied with the configuration, click Save to create the monitor.

3.2 Setting Up Webhook Integration for Alerts

• Access Alerting:
• From the homepage, navigate to Alerting.
• Configure Integrations:
• Click on Integrations, then select Add Integration.
• Choose Custom Integration and give the integration a name (e.g., "Callgoose SQIBS Integration").
• Configure Predefined Variables:
• In the Predefined Variables section, add the Callgoose SQIBS API endpoint URL as the value for the variable name ApiUrl.
• Customizing the Payload:
• Click on Customizations to modify the JSON payload body. By default, the payload will look something like this. You can customize this to include additional data or modify it to more meaningful.

json

{
  "alert": {
    "alertGuid": "{{@alert.alertGuid}}",
    "type": "{{@alert.type}}",
    "description": "{{@JsonEncode({{@alert.description}})}}",
    "failureMessage": "{{@alert.failureMessage}}",
    "timestampUtc": "{{@alert.timestampUtc}}",
    "timestamp": "{{@alert.timestamp}}",
    "timestampUtcFormatted": "{{@alert.timestampUtcFormatted}}",
    "timestampFormatted": "{{@alert.timestampFormatted}}",
    "firstErrorUtc": "{{@alert.firstErrorUtc}}",
    "firstError": "{{@alert.firstError}}",
    "firstErrorUtcFormatted": "{{@alert.firstErrorUtcFormatted}}",
    "firstErrorFormatted": "{{@alert.firstErrorFormatted}}",
    "firstErrorCheckUrl": "{{@alert.firstErrorCheckUrl}}",
    "firstErrorCheckId": "{{@alert.firstErrorCheckId}}",
    "serverIpv4": "{{@alert.serverIpv4}}",
    "serverIpv6": "{{@alert.serverIpv6}}",
    "resolvedIpAddress": "{{@alert.resolvedIpAddress}}",
    "responseBody": "{{@JsonEncode({{@alert.responseBody}})}}",
    "downtimeDuration": "{{@alert.downtimeDuration}}"
  },
  "alertDefinition": {
    "guid": "{{@alertDefinition.guid}}",
    "name": "{{@alertDefinition.name}}"
  },
  "escalationLevel": {
    "id": "{{@escalationLevel.id}}",
    "message": "{{@escalationLevel.message}}"
  },
  "incident": {
    "key": "{{@incident.key}}"
  },
  "monitor": {
    "guid": "{{@monitor.monitorGuid}}",
    "name": "{{@monitor.name}}",
    "type": "{{@monitor.type}}",
    "url": "{{@monitor.url}}",
    "notes": "{{@JsonEncode({{@monitor.notes}})}}",
    "dashboardUrl": "{{@monitor.dashboardUrl}}",
    "editUrl": "{{@monitor.editUrl}}"
  },
  "account": {
    "id": "{{@account.accountId}}"
  },
  "source": "Uptrends",
  "version": "1.0"
}

Refer Alerting System Variables for more details about these variables.

• Test the Integration:
• Use the Test Alert option to ensure that the webhook is properly sending data to Callgoose SQIBS and that the payload format matches the required structure.
• Save the Integration:
• After confirming that the webhook is working correctly, click Save to finalize the integration.

3.3 Setting Up an Alert Definition

• Go to Alert Definitions:
• From the Alerting section, click on Alert Definitions.
• Create a New Alert Definition:
• Click on Add Alert Definition and give it a descriptive name (e.g., "Page Load Time Alert").
• Select the Monitor:
• Choose the monitor you want to associate with this alert definition from the list of available monitors.
• Configure Escalation Levels:
• Under Escalation Level 1, select Custom Integration from the Alerting by Integration field.
• Ensure that the previously configured Callgoose SQIBS integration is selected.
• Refer Alert Definition Documentation for more details.
• Save the Alert Definition:
• Once everything is configured, click Save to apply the alert definition.

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

4.1.1 Example JSON Payloads from Uptrends

Alert Triggered (type: "Alert")

json

{
"alert": {
"alertGuid": "c2faab1d-0f5c-49b7-b0fb-1d0b03cbea85",
"type": "Alert",
"description": "First Contentful Paint threshold was exceeded.\nFirst Contentful Paint exceeded its threshold of 1600 ms.",
"failureMessage": "",
"timestampUtc": "2024-10-07T04:17:12",
"timestamp": "2024-10-07T09:47:12",
"timestampUtcFormatted": "10/7/2024 4:17 AM",
"timestampFormatted": "10/7/2024 9:47 AM",
"firstErrorUtc": "2024-10-07T04:17:12",
"firstError": "2024-10-07T09:47:12",
"firstErrorUtcFormatted": "10/7/2024 4:17 AM",
"firstErrorFormatted": "10/7/2024 9:47 AM",
"firstErrorCheckUrl": "https://app.uptrends.com/Report/ProbeLog/Check/163920824567",
"firstErrorCheckId": "163920824567",
"serverIpv4": "103.152.254.60",
"serverIpv6": "",
"resolvedIpAddress": "216.24.57.252",
"responseBody": "",
"downtimeDuration": "0:00:00"
},
"alertDefinition": {
"guid": "9e3528d7-346d-4a8b-b602-d4dcfcbc6f34",
"name": "Test"
},
"escalationLevel": {
"id": "1",
"message": "WebPage Error"
},
"incident": {
"key": "9e3528d7-346d-4a8b-b602-d4dcfcbc6f34-0-163920824567"
},
"monitor": {
"guid": "39023ddf-cba8-4eb3-bd03-9ac3527d4edd",
"name": "BlackBoxai",
"type": "FullPageCheck",
"url": "https://www.blackbox.ai/",
"notes": "Webpage Error",
"dashboardUrl": "https://app.uptrends.com/Probe/Dashboard?probeGuids=39023ddf-cba8-4eb3-bd03-9ac3527d4edd",
"editUrl": "https://app.uptrends.com/Report/Probe?probeGuid=39023ddf-cba8-4eb3-bd03-9ac3527d4edd"
},
"account": {
"id": "432312"
},
"source": "Uptrends",
"version": "1.0"
}

Alert Resolved (type: "Ok")

json

{
"alert": {
"alertGuid": "fad4ccba-5d30-4f25-ae47-7e40409bee88",
"type": "Ok",
"description": "",
"failureMessage": "",
"timestampUtc": "2024-10-07T04:22:35",
"timestamp": "2024-10-07T09:52:35",
"timestampUtcFormatted": "10/7/2024 4:22 AM",
"timestampFormatted": "10/7/2024 9:52 AM",
"firstErrorUtc": "2024-10-07T04:17:12",
"firstError": "2024-10-07T09:47:12",
"firstErrorUtcFormatted": "10/7/2024 4:17 AM",
"firstErrorFormatted": "10/7/2024 9:47 AM",
"firstErrorCheckUrl": "https://app.uptrends.com/Report/ProbeLog/Check/163920824567",
"firstErrorCheckId": "163920824567",
"serverIpv4": "43.245.161.98",
"serverIpv6": "2407:a080:7000:10e::2",
"resolvedIpAddress": "216.24.57.4",
"responseBody": "",
"downtimeDuration": "0:05:22"
},
"alertDefinition": {
"guid": "9e3528d7-346d-4a8b-b602-d4dcfcbc6f34",
"name": "Test"
},
"escalationLevel": {
"id": "1",
"message": "WebPage Error"
},
"incident": {
"key": "9e3528d7-346d-4a8b-b602-d4dcfcbc6f34-0-163920824567"
},
"monitor": {
"guid": "39023ddf-cba8-4eb3-bd03-9ac3527d4edd",
"name": "BlackBoxai",
"type": "FullPageCheck",
"url": "https://www.blackbox.ai/",
"notes": "Webpage Error",
"dashboardUrl": "https://app.uptrends.com/Probe/Dashboard?probeGuids=39023ddf-cba8-4eb3-bd03-9ac3527d4edd",
"editUrl": "https://app.uptrends.com/Report/Probe?probeGuid=39023ddf-cba8-4eb3-bd03-9ac3527d4edd"
},
"account": {
"id": "432312"
},
"source": "Uptrends",
"version": "1.0"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Uptrends 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: "alert"."type"
• Key Value Contains: [Alert, Reminder]
• Map Incident With: "incident"."key"
• This corresponds to the unique incident.key from the Uptrends 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.
• Example: If you use the "alert"."description" key in the Incident Description From field, the incident description will be the value of the "alert"."description" key. In the example JSON payload provided earlier, this would result in a description like "First Contentful Paint threshold was exceeded.\nFirst Contentful Paint exceeded its threshold of 1600 ms.".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "alert"."type"
• Key Value Contains: [OK]
• Incident Mapped With: "incident"."key"
• This ensures the incident tied to the specific incident.key 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 Uptrends.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Uptrends that causes an alert (e.g., when the page load time exceeds 1000ms. on a monitored server).
• 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 Uptrends (e.g., when the page load time 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.
• Uptrends Permissions: Confirm that the webhook in Uptrends 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 Uptrends 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 Uptrends matches the expected structure.

8. Conclusion

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

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