Overview
Send Kubeshark API traffic alerts to Callgoose SQIBS. A Kubeshark script watches the captured traffic, and when HTTP 5xx errors spike it posts an alert to your SQIBS API endpoint; when the errors stop it posts a recovery. SQIBS opens and resolves the incident to match.
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 Kubeshark template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "status" |
firing |
Opens an incident. |
| Resolve | "status" |
resolved |
Resolves the open incident. |
| Match | "alert_key" |
Ties the recovery to the incident it opened. | |
| Title from | "summary" |
Becomes the incident title. |
- Choose the Priority for these incidents and click Save.
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 script
Save this script in your Kubeshark scripts folder, for example callgoose-5xx.js. Adjust the threshold to your traffic:
// Kubeshark script: count HTTP 5xx responses and tell Callgoose SQIBS when they spike or recover.
// WEBHOOK_URL comes from scripting.env in the Kubeshark config.
var errors = 0;
var firing = false;
function onItemCaptured(data) {
if (data.protocol && data.protocol.name === "http" && data.response && data.response.status >= 500) {
errors++;
}
}
function checkErrors() {
var spike = errors > 10; // more than 10 errors in the last minute
if (spike !== firing) {
firing = spike;
vendor.webhook("POST", env.WEBHOOK_URL, JSON.stringify({
status: spike ? "firing" : "resolved",
alert_key: "kubeshark-http-5xx",
summary: spike ? "HTTP 5xx spike: " + errors + " errors in the last minute" : "HTTP 5xx errors back to normal",
errors_last_minute: errors
}), { "Content-Type": "application/json" });
}
errors = 0;
}
jobs.schedule("callgoose-5xx", "0 */1 * * * *", checkErrors);
Step 3: Point Kubeshark at the script and SQIBS
Add the endpoint and the scripts folder to your Kubeshark config (~/.kubeshark/config.yaml, or the scripting section of the Helm values):
scripting:
env:
WEBHOOK_URL: "https://<your-endpoint>/sqibs-api/v1/process?from=kubeshark&token=<your-token>"
source: /path/to/scripts
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Restart Kubeshark (kubeshark tap again, or upgrade the Helm release) so it loads the script. The script's output shows in the Kubeshark dashboard's scripting console.
Hooks run on each Kubeshark worker, so each node counts its own traffic. If you run several workers, add the node name to alert_key so each node has its own incident.
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.
- Send some requests to a test service that returns 500, for example with a small loop of
curlcalls. - Within a minute, a new incident opens in SQIBS, titled with the error count.
- Stop the errors. After the next check, the script sends
resolvedand 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 script's WEBHOOK_URL.
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 Kubeshark sees a 5xx spike on a service, SQIBS can run a kubectl workflow that restarts the failing pods.
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.