Prerequisites
- Prefect Cloud account or self-hosted Prefect Server
- API key (Prefect Cloud) or accessible API URL (self-hosted)
Setup
Option 1: Interactive CLI
Option 2: Persistent store
Add to~/.config/healops/integrations.json:
Prefect Cloud setup
- In Prefect Cloud, go to your profile icon → API Keys
- Click Create API Key
- Copy the key, account ID, and workspace ID from the URL:
https://app.prefect.cloud/account/<account-id>/workspace/<workspace-id>/
Self-hosted Prefect Server
For self-hosted Prefect Server, setapi_url to your server’s API endpoint (no API key required if unauthenticated):
Investigation tools
When HealOps investigates a Prefect-related alert, three diagnostic tools are available:- Flow runs — lists recent flow runs filtered by state (FAILED, CRASHED, etc.)
- Flow run logs — retrieves log output for a specific flow run
- Workers — checks worker health and heartbeat status across work pools
Troubleshooting
Security best practices
- Use a service account API key rather than a personal key.
- For self-hosted, restrict network access to the Prefect API to trusted IPs.
- Store credentials in
~/.config/healops/integrations.json, not in source code.
Tracer