Skip to content

Monitoring ​

Health endpoints ​

EndpointMeaning
GET /api/healthUnauthenticated; {"ok":true} when the API is up
Plugin host GET /healthUnauthenticated, reachable only on the internal network: {ok, version, sandbox}

Docker Compose runs a health check on the plugin host; docker compose ps shows it.

Prometheus ​

GET /api/metrics returns Prometheus text. It is administrator only and, today, only an administrator session can read it: API tokens cannot reach it. That makes unattended scraping awkward (a scraper has to hold an administrator session cookie). Until a dedicated metrics token exists, either scrape from a trusted small script that reuses a long-lived administrator session, or use the notifications and the Resilience page for alerting. The metrics:

MetricLabelsMeaning
fledge_nodesstatusRegistered nodes by connection state
fledge_serversstatusServers by observed state
fledge_jobsstateJobs by state
fledge_failover_eventsstateFailover events by state
fledge_servers_without_backupServers that have no successful backup
fledge_servers_crash_loopingServers whose automatic restarts were stopped
fledge_notification_channels_failingChannels whose last delivery failed
fledge_schedule_runsstateSchedule runs in the last 24 hours
fledge_pluginsenabledInstalled plugins
fledge_server_addonsstateTracked add-ons
fledge_sessions, fledge_passkeysActive sessions and registered passkeys

Example alert rules:

yaml
- alert: FledgeNodeDown
  expr: fledge_nodes{status="disconnected"} > 0
  for: 5m
- alert: FledgeServersWithoutBackup
  expr: fledge_servers_without_backup > 0
  for: 1d
- alert: FledgeCrashLoop
  expr: fledge_servers_crash_looping > 0

History in the panel ​

Each server's Usage tab keeps CPU and memory history (1 hour to 30 days; see Usage history).

Notifications ​

Instead of polling, let Fledge tell you: Notifications cover node offline/online, crashes, crash loops, low disk, failed backups, failover, failed schedules and plugin problems.

Logs ​

sh
docker compose logs -f api web plugins
docker compose logs --since 10m api

API logs are JSON lines. On a node: journalctl -u fledge-agent -f. A plugin's own log lines appear in Plugins → (plugin) → Logs.

Released under the AGPL-3.0-only license.