1What FoxPlug reads from Checkly
These are the exact things it reads, and nothing else.
| What | The details it takes |
|---|---|
| The pass or fail state of every check | one request returns the status of each check: its id and whether it has failures or errors right now |
| The names of your checks | the first 100 checks are listed so a failing check can be called by name instead of by id |
| Which checks were failing at the last press | the ids of failing checks and when FoxPlug first saw each one failing are kept on the connection, so the next press can tell a check has recovered |
| A one-line summary of the read | how many checks exist and how many are failing right now, shown in the success message |
2Moments it finds, and what each becomes
A moment is one thing that happened in Checkly worth a second look. Each one is scored, then it becomes a post, a changelog entry, a thing to fix or an idea to email, or it is skipped.
a check is failing right now
The moment is titled like this: Login flow check is down
Your Checkly check named Login flow check reports failures when you press Check for what's new. FoxPlug makes the moment 'Login flow check is down' with the line that it has been down since the moment FoxPlug first saw it failing. It is held from posting and shows first in the Today brief.
a check that was failing at your last press passes again
The moment is titled like this: Login flow check was down for 3 hours and is back
At your next press the same check passes. FoxPlug makes 'Login flow check was down for 3 hours and is back'. The length is the time between the two presses where it was first seen failing and where it was seen passing, not the exact outage, and the update can be skipped.
3How the brain uses it
The rules below are the ones that apply to Checkly. The same rules, with worked examples, are on the brain page.
- A monitor that is down becomes the first card in the Today brief and stays until the monitor reports it back up or three days pass. It is never posted and nothing about it is upbeat. How the brain decides
- When an incident is over, one short honest update says how long it was down and that it is fixed. It is written only when you press Check for what's new, and you can skip it. How the brain decides
- Checkly gives no percentage through its API key, so for Checkly only down and back-up are used. How the brain decides
- Reads happen only when you press Build the brief or Check for what's new, never in the background. How the brain decides
4Set up Checkly in a few steps
Access: API key plus your Account ID (a second box). What to give it: API key plus Account ID.
- Open app.checklyhq.com/settings/user/api-keys and sign in.
- Press Create API key and name it FoxPlug.
- Copy the key now. Checkly shows it only once.
- Open Account settings, General, and copy the Account ID.
- Paste the key into FoxPlug, and the Account ID into the second field.
5Limits worth knowing
Where it stops, so nothing surprises you.
- Without the Account ID the read stops at once with a plain message that the Account ID is needed.
- Only the first 100 checks are listed for names; a check beyond that is shown by its id.
- Checkly gives only the state right now, so how long a check was down is measured between your presses, not from the real start of the outage.
- A check that is already failing the first time you press is dated from that press.
- A refused key or Account ID (401 or 403) stops the read with a plain message; any other failed reply stops it with the status number.
- No uptime-percentage moment is ever made for Checkly.
6What it never reads
Read only means read only, and the list below is what the code leaves alone.
- Check results, screenshots, traces or scripts (only the status list and the check list are requested)
- An uptime percentage: Checkly gives none through this connection and FoxPlug works none out
- Anything it writes back: no check is created, edited, muted or deleted
7Questions
Is the Checkly key read-only?
No. The connect panel says the key is tied to your user and can do whatever you can. FoxPlug only sends read requests: the list of checks and whether each one is failing.
Why do I need the Account ID?
Checkly's requests are made per account, so the Account ID is sent with every one. It is under Account settings, General.
Why no uptime percentage for Checkly?
Checkly gives none through this connection, so FoxPlug uses only down and back-up.
How accurate is the 'was down for' time?
It is only as fine as how often you press Check for what's new, because Checkly reports only the current state.
When does it look at Checkly?
Only when you press Check for what's new.
FoxPlug reads this tool only when you press Check for what's new, and only to read. Plans and limits are on the pricing page. Questions: support.