Skip to content

by Startups.Studio

Product Build and ship Monitor

Monitor.check

POST /{namespace}/monitors/{monitor}/check

Check runs a Monitor once now from several regions and records the result as an Event.

Noun: Monitor
Mode: do
Event: Monitor.checked

You, to your agent

Check the latest monitor.

curl -X POST https://api.sb/quietcopy.com/monitors/monitor_1/check \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const monitor = await $.Monitor.check({ monitor: 'monitor_1' })

npx startup-builder do Monitor.check --json '{"monitor":"monitor_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Monitor.check({ monitor: 'monitor_1' })"
  }
}

Inputs

Input	Type	Required	Description
`monitor`	Monitor	required	The Monitor to run.

Outputs

Output	Type	Required	Description
`monitor`	Monitor	required	The Monitor, with its latest result.

Effects

Emits Monitor.checked.
Performed by the Reliability Engineer.
Two-way: it runs at once, in the try, send and do modes.
A failing internal Monitor opens an Incident.
A failing outside Monitor records a signal Event for the Teams that read it.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Monitor.check

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Monitor

Previous Page

Monitor.create

Next Page