Uptrace

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Uptrace

• Log in to Uptrace
• Open the Uptrace website and log in using your account credentials.
• Connect Your Application to Uptrace
• Inside the Uptrace dashboard, add your application.
• To start sending tracing data to Uptrace, configure the OpenTelemetry Tracing SDK in your application.
• For more detailed instructions, click on Overview within Uptrace. Follow the on screen steps if your application is not already connected.

3.2 Setting Up Webhook in Uptrace

• Set Up Alerting in Uptrace
• In the Uptrace dashboard, move your cursor to Alerting.
• Choose Notification Channels from the dropdown.
• Create a New Notification Channel
• Click on New Channel.
• Select Webhook as the notification method.
• Configure the Webhook
• In the webhook configuration:
• Name: Enter any name you like for the webhook channel.
• Webhook URL: Paste the endpoint URL provided by Callgoose SQIBS here.
• Note: The final API endpoint may vary based on authentication and other URL parameters. Find the final API endpoint here: Callgoose SQIBS Endpoint.
• In the optional JSON payload, you can add new key-value pairs to make the alert data more meaningful.
• Choose Monitors and Finalize
• Select the monitors you want associated with this alert channel. (You can add new monitor by moving cursor to Alerting, choose Monitors).
• Click Create to save the new webhook channel.

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

4.1.1 Example JSON Payloads from Uptrace

Alert Triggered (state: "open")

json

{
  "id": "****",
  "eventName": "created",
  "payload": null,
  "createdAt": "2024-11-04T10:20:00Z",
  "alert": {
    "id": "181374",
    "url": "https://app.uptrace.dev/alerting/****/alerts/181374",
    "name": "ERROR Jackdaws love my big sphinx of quartz.",
    "type": "error",
    "state": "open",
    "status": "open",
    "createdAt": "2024-11-04T10:22:20.603558Z"
  }
}

Alert Resolved (state: "closed")

json

{
  "id": "****",
  "eventName": "status-changed",
  "payload": null,
  "createdAt": "2024-11-04T10:51:24.80129Z",
  "alert": {
    "id": "181374",
    "url": "https://app.uptrace.dev/alerting/****/alerts/181374",
    "name": "ERROR Jackdaws love my big sphinx of quartz.",
    "type": "error",
    "state": "closed",
    "status": "closed",
    "createdAt": "2024-11-04T10:22:20.603558Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Uptrace 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"."state"
• Key Value Contains: [open]
• Map Incident With: "alert"."id"
• This corresponds to the unique alert.id from the Uptrace 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"."name" key in the Incident Description From field, the incident description will be the value of the "alert"."name" key. In the example JSON payload provided earlier, this would result in a description like ""ERROR Jackdaws love my big sphinx of quartz.".".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "alert"."state"
• Key Value Contains: [closed]
• Incident Mapped With: "alert"."id"
• This ensures the incident tied to the specific alert.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 Uptrace.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Uptrace that causes an alert (e.g., Make a logging error in the connected application).
• 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 Uptrace (e.g., Close the error in Uptrace), 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.
• Uptrace Permissions: Confirm that the webhook in Uptrace 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 Uptrace 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 Uptrace matches the expected structure.

8. Conclusion

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

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