Integrations
Lumigo
Overview
This document provides a detailed guide to integrating Lumigo with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, and Event-Driven Automation.
This integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on alerts generated in Lumigo (Serverless Observability). The guide includes steps for configuring Webhook notifications in Lumigo, understanding JSON payloads, creating API filters in Callgoose SQIBS, and troubleshooting.
Prerequisites
- Lumigo Account: Access to the Lumigo Console with permissions to manage Integrations and Alerts.
- Callgoose SQIBS Account: Permissions to create API filters and manage services.
- Webhook/API Endpoint: Generated in Callgoose SQIBS.
- API Token: From Callgoose SQIBS.
1. Obtain API Token and Endpoint Details
To integrate with Callgoose SQIBS, first obtain an API token and endpoint URL.
1.1 Generate an API Token
Follow the document: How to Create API Token in Callgoose SQIBS. Copy the generated token for later use.
1.2 Find the API Endpoint
Refer to Callgoose SQIBS API Endpoint Documentation. Your endpoint will follow the format: https://****.callgoose.com/v1/process?from=Lumigo&token=xxxx
Note: Ensure the from parameter is set to Lumigo to easily identify the source in logs.
2. Configuring Lumigo to Send Alerts
Lumigo sends alerts via Webhooks attached to specific Alert Policies. You will configure a Webhook integration that pushes a JSON payload to Callgoose SQIBS.
2.1 Access Lumigo
Log in to your Lumigo console. Ensure you have the necessary roles (Admin or Editor) to configure integrations.
2.2 Create a Webhook Integration
- Navigate to Settings → Integrations.
- Locate the Webhooks tile and click Add Integration.
- Configure the Webhook:
- Alias: Callgoose SQIBS Integration
- URL: Your API Endpoint (from Step 1.2).
- Authorization: (Leave blank as the token is in the URL).
- Click Save.
2.3 Webhook Payload Configuration
Unlike some tools that allow custom JSON templates, Lumigo sends a fixed standard JSON payload. You do not need to define a template in Lumigo.
However, you must be aware of the payload structure to configure Callgoose SQIBS filters effectively.
- Key Fields: issue.id, issue.type, issue.level, resource.name, timestamp.
- See Section 3 for the exact JSON structure.
2.4 Attach Notification to an Alert
- Navigate to Alerts in the sidebar.
- Click Create New Alert (or edit an existing one).
- Define the Alert logic (e.g., Function Error Rate > 1%).
- Scroll to the Notifications section.
- Select the Webhooks channel you created in Step 2.2 (Callgoose SQIBS Integration).
- Click Save Alert.
2.5 Test the Webhook
- Go to the Integrations page where you created the webhook.
- Click the Test button (if available) or trigger a "Test Fire" from an existing Alert policy.
- Verify that Callgoose SQIBS receives the test alert in the API Logs.
3. Example JSON Payloads From Lumigo
Based on Lumigo's standard webhook schema, the payloads will appear in the following format.
3.1 Triggered Alert Payload
When an issue is detected (e.g., Error):
JSON
{
"issue": {
"id": "issue_12345",
"type": "ProgrammaticError",
"level": "error",
"name": "TypeError: Cannot read property 'x' of undefined",
"link": "https://platform.lumigo.io/..."
},
"resource": {
"name": "payment-service-lambda",
"region": "us-east-1",
"type": "lambda"
},
"timestamp": 1616161616161
}
3.2 Resolved Alert Payload
Note: Lumigo primarily sends event-based alerts. If a "Resolved" state is supported for specific metric alerts, the payload will typically update the state field.
JSON
{
"issue": {
"id": "issue_12345",
"state": "resolved",
"level": "info"
},
"timestamp": 1616161900000
}
4. Configuring Callgoose SQIBS
4.1 Create API Filters
API filters are required to map incoming alert payloads to incidents. You will map the JSON fields from Lumigo to SQIBS incident fields.
4.1.1 Trigger Filter (For Creating Incidents)
- Payload JSON Key: issue.level
- Key Value Contains: error (or critical).
- Map Incident With: issue.id (This ensures unique identification per issue).
- Incident Title: {{issue.type}}: {{issue.name}}
- Incident Description: name(or leave empty to recieve full payload as description)
- Additional Mapping: Map issue.link to the incident "Link" or "Source URL" field if available.
4.1.2 Resolve Filter (For Resolving Incidents)
- Payload JSON Key: issue.state
- Key Value Contains: resolved
- Incident Mapped With: issue.id (Must match the key used in the Trigger Filter).
5. Testing & Validation
5.1 Triggering Alerts
- In Lumigo (or your AWS environment), trigger a test error in a monitored function (e.g., throw a dummy exception).
- Confirm Lumigo sends the alert payload.
- Confirm a new incident appears in Callgoose SQIBS.
5.2 Resolving Alerts
- If using a metric-based alert that auto-resolves, wait for the metric to stabilize.
- Confirm Lumigo sends the resolved payload (if applicable).
- Confirm the incident in Callgoose SQIBS auto-resolves.
6. Debugging & Troubleshooting
- Enable Debug in the Callgoose SQIBS API Token settings.
- Review Logs under API Log in Callgoose SQIBS.
- Lumigo Logs: Check the Integration status in Lumigo to ensure the webhook was sent and received a 200 OK response.
- Common Issues:
- No incident created: Incorrect Webhook URL or the Trigger Filter is looking for issue.status instead of issue.level. Ensure the filter matches the JSON structure shown in Step 3.
- Incident not resolved: Mismatched issue.id between the Trigger and Resolve filters.
- Malformed JSON: Although Lumigo sends fixed JSON, ensure your API Filter parsing syntax (handlebars {{ }}) is correct.
7. Security Considerations
- Keep the API token private.
- Use HTTPS endpoints only for the Webhook URL.
- Rotate API tokens periodically in Callgoose SQIBS settings.
8. Conclusion
By following this guide, you can integrate Lumigo with Callgoose SQIBS for seamless incident creation, updates, and resolution. This ensures your DevOps and Operations teams have real-time visibility into Serverless Application Performance issues.
For additional reference:
