Overview

Send Cacti threshold alerts to Callgoose SQIBS. The Thold plugin runs a command when a threshold is breached and another when it restores; both post to your SQIBS API endpoint. SQIBS opens an incident on the breach and resolves it on restore.

You need
Cacti with the Thold plugin and shell access to the Cacti server, and a SQIBS API token
Setup time
About 20 minutes
Result
Cacti threshold breaches open SQIBS incidents; restores resolve them

How it works

Cacti
Alert fires
A threshold is breached.
Cacti
Sends a webhook
Thold runs a command that posts JSON with curl.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
ALERT opens it, RESTORE 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

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in Cacti template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "state" ALERT Opens an incident.
Resolve "state" RESTORE Resolves the open incident.
Match "key" Host and threshold: ties the restore to its alert.
Title from "threshold" Becomes the incident title.
Description from "host" The host becomes the description.
  1. Choose the Priority for these incidents and click Save.

Thold's replacement tags (such as <HOSTNAME>, <NAME> and <CURRENTVALUE>) vary slightly between Thold versions; check the list shown in your threshold form.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
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 notification script

On the Cacti server, save this as /usr/local/bin/callgoose-thold.sh and make it executable:

#!/bin/sh
# Called by the Cacti Thold plugin. $1 = ALERT or RESTORE, the rest come from Thold replacement tags.
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=cacti&token=<your-token>" \
  -H 'Content-Type: application/json' \
  -d "{\"state\": \"$1\", \"host\": \"$2\", \"threshold\": \"$3\", \"value\": \"$4\", \"key\": \"$2/$3\"}"

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: Call it from Thold

  1. In Cacti, open Console > Configuration > Settings > Alerting/Thold and make sure command execution is enabled.
  2. Edit the threshold (or threshold template). In Trigger Command enter /usr/local/bin/callgoose-thold.sh ALERT '<HOSTNAME>' '<NAME>' '<CURRENTVALUE>'.
  3. In Restoration Command enter the same with RESTORE instead of ALERT.
  4. Save the threshold.

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.

  1. Lower a threshold below the current value so it triggers.
  2. In SQIBS, a new incident opens, titled with the threshold name. The payload looks like this:
{
  "state": "ALERT",
  "host": "core-router-1",
  "threshold": "Traffic In - Gi0/1",
  "value": "940.2 Mbps",
  "key": "core-router-1/Traffic In - Gi0/1"
}
  1. Put the threshold back. When Thold restores it, 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 Thold commands.

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 Cacti reports a saturated uplink, SQIBS can run a workflow that collects the top talkers and shifts traffic to the backup link.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

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:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. 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: