Overview
Report errors from functions deployed with the Serverless Framework to Callgoose SQIBS. Your function posts a small JSON message to your SQIBS API endpoint when it fails and when it succeeds again. SQIBS opens an incident on the failure and resolves it on the next success.
How it works
firing opens it, resolved closes it.Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.
Step 1: Add the API filter in SQIBS
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in Serverless Framework template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "state" |
firing |
Opens an incident. |
| Resolve | "state" |
resolved |
Resolves the open incident. |
| Match | "service" |
The function name: ties the success to the failure. | |
| Title from | "message" |
Becomes the incident title. |
- Choose the Priority for these incidents and click Save.
A success with no open incident is ignored, so sending resolved on every success is safe. For alarms on Lambda metrics (errors, throttles, duration) without code changes, use the AWS Cloud (Amazon SNS) page instead.
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
In the API Integration window, click the round
{} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.Step 2: Add the endpoint to your service
- Store your SQIBS token in AWS Systems Manager Parameter Store as
/callgoose/sqibs-token(SecureString). - Add the endpoint and token to
serverless.yml:
service: orders
provider:
name: aws
runtime: nodejs20.x
environment:
SQIBS_URL: https://<your-endpoint>/sqibs-api/v1/process?from=serverless
SQIBS_TOKEN: ${ssm:/callgoose/sqibs-token}
functions:
processOrder:
handler: handler.processOrder
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Report failures from the function
Wrap the function's work so it reports the outcome. The token goes in the Authorization: Bearer header, so it never appears in a URL:
// handler.js - report failures of this function to Callgoose SQIBS (Node.js 20, built-in fetch)
const notify = (state, message) =>
fetch(process.env.SQIBS_URL, {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: `Bearer ${process.env.SQIBS_TOKEN}` },
body: JSON.stringify({
state, // "firing" or "resolved"
service: process.env.AWS_LAMBDA_FUNCTION_NAME,
message,
}),
}).catch(() => {}); // never fail the function because of the alert
exports.processOrder = async (event) => {
try {
const result = await doWork(event); // your code
await notify("resolved", "processOrder succeeded");
return result;
} catch (err) {
await notify("firing", `processOrder failed: ${err.message}`);
throw err; // keep Lambda's own retry and error metrics
}
};
Deploy with serverless deploy.
Step 4: Test it
The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.
- Invoke the function with an input that makes it fail:
serverless invoke -f processOrder --data '{"bad": true}'. - In SQIBS, a new incident opens, titled with the error message.
- Invoke it with a good input. The function sends
"state": "resolved"and SQIBS resolves the incident.
No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in the function's environment.
Fix known issues automatically
Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when the order function fails because a downstream queue is full, SQIBS can run a workflow that drains the dead-letter queue and replays the messages.
Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.
To set it up, in the same API filter:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.
Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.
Learn more:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.