Developer documentation
These guides show you how to connect your monitoring tools to adoe, write the SOPs it follows, and call its API. If you run adoe on your own server, start with Getting started.
-
Getting started
Run your own adoe server with Docker Compose. Set its environment variables, create your admin account, and point your tools at it.
-
Integration setup
Connect Sensu, Splunk, PagerDuty, Grafana, Uptime.com, Railway, Slack and Semaphore. Covers webhook URLs, signing secrets and the fields adoe reads from each tool.
-
SOP authoring
Write the YAML SOPs that adoe matches to alerts: preconditions, runbook steps, verification, and drafts discovered from GitHub and Confluence.
-
API and webhook reference
The endpoints you need to send alerts and manage SOPs, how they authenticate, and curl examples for sending a test alert.
Words these guides use
Each term means one thing, everywhere in these guides.
- Alert
- What your monitoring tool sends to adoe.
- Incident
- What adoe works on: one or more related alerts grouped together.
- SOP
- The procedure that checks and decides. It says which alert it covers, what must be true, which runbook to run, and how to verify the fix.
- Runbook
- The steps an SOP runs: a GitHub Actions workflow, an SSM document, a script or an SSH command.
- Verify
- Check the alert's own signal after an action, to confirm the fix worked.
- Escalate
- Hand the incident to a person, with the hypothesis and the evidence.