Scout APM

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Scout APM

• Log in to Scout APM
• Go to your Scout APM account and log in.
• Connect Your Application to Scout APM
• If your application is not yet connected to Scout APM, follow the instructions in the Install Agents documentation provided by Scout APM to set up the necessary agents.
• Once connected, data may take some time to appear on the Scout APM Dashboard.

3.2 Setting Up Webhook in Scout APM

• Set Up Webhook Notification
• Once data starts showing in the Dashboard, go to Alerts in the Scout APM menu.
• Click on Notification Channels.
• Select New Webhook.
• Enter a name for the webhook.
• In the Webhook URL field, paste the Endpoint URL provided by Callgoose Sqibs. This will serve as the endpoint to which alert notifications will be sent.
• Note: The final API endpoint may vary depending on authentication and URL parameters. Ensure you have the correct endpoint. Find your final API Endpoint here.
• After setting up the URL, click Create Channel to complete webhook creation.
• Add Webhook to Notification Group
• Go to Notification Group.
• Click on Add Some Channels.
• Select the webhook you created earlier.
• Click on Update Notification Group to save changes.
• Create an Alert Condition
• Go to Alert Condition.
• Choose a condition type, e.g., All Web Points.
• Configure the condition according to your requirements.
• Example: Web - Throughput requests per minute ≥ 10 for 1 minute.
• Ensure that the Notify option is selected as default, as this uses the notification group created in previous steps.
• Click Create Alert Condition to finalize the alert setup.

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

4.1.1 Example JSON Payloads from Scout APM

Alert Triggered (open: "true")

json

{
  "id": 3571061,
  "org_id": ****,
  "app_id": ****,
  "app_name": "MyTestApp",
  "org_name": "Zerox",
  "alert_condition_id": 5035,
  "url": "https://scoutapm.com/apps/****?alert_id=3571061",
  "kind": "closable",
  "continued_at": "2024-10-25T09:50:59.999Z",
  "started_at": "2024-10-25T09:50:00.000Z",
  "closed_at": null,
  "open": true,
  "description": "throughput >= 2.0 /min",
  "metric": " throughput",
  "threshold": ">= 2.0 /min"
}

Alert Resolved (open: "false")

json

{
  "id": 3571061,
  "org_id": 128644,
  "app_id": 375530,
  "app_name": "MyTestApp",
  "org_name": "Zerox",
  "alert_condition_id": 5035,
  "url": "https://scoutapm.com/apps/375530?alert_id=3571061",
  "kind": "closable",
  "continued_at": "2024-10-25T09:51:59.999Z",
  "started_at": "2024-10-25T09:50:00.000Z",
  "closed_at": "2024-10-25T09:52:59.999Z",
  "open": false,
  "description": "throughput >= 2.0 /min",
  "metric": " throughput",
  "threshold": ">= 2.0 /min"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Scout APM 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: "open"
• Key Value Contains: [true]
• Map Incident With: "id"
• This corresponds to the id from the Scout APM payload.
• Incident Title From: "app_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 "description" key in the Incident Description From field, the incident description will be the value of the "description" key. In the example JSON payload provided earlier, this would result in a description like "throughput >= 2.0 /min".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "open"
• Key Value Contains: [false]
• Incident Mapped With: "id"
• This ensures the incident tied to the specific 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 Scout APM.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Scout APM that causes an alert (e.g., when requests per minute exceed 10 on a monitored App, Manually trigger this condition).
• 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 Scout APM (e.g., when throughput 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.
• Scout APM Permissions: Confirm that the webhook in Scout APM 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 Scout APM 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 Scout APM matches the expected structure.

8. Conclusion

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

• Scout APM 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 Scout APM.