Monitoring, Health & Logging
Operational visibility comes from health endpoints (system, workspace), status signals (AI, email, Stripe), and log tables — activity logs, automation logs, and API request logs.
#Purpose
Show developers where to look to confirm the system is healthy and to investigate issues.
#Architecture
Health endpoints report system and workspace health. Status signals expose the readiness of AI, email/auth-email, and Stripe. Activity is recorded in activity logs; background-job runs in automation logs; and public-API calls in API request logs.
These surfaces back the administrator Monitoring guides and give developers concrete signals to check.
#How it works
1
Check health
Query the health/status surfaces to confirm normal operation.
2
Inspect logs
Use activity, automation, and API request logs to investigate.
3
Correlate
Match a symptom to the relevant dependency status.
4
Act
Fix the underlying dependency (email, AI, integration).
#Reference
#Signals & logs
| Surface | Purpose |
|---|---|
| Health endpoints | System / workspace health |
| AI / email / Stripe status | Readiness of key dependencies |
| activity_logs | Recorded actions (actor, message) |
| automation_logs | Background-job run outcomes |
| api_request_logs | Public-API request records |
#Implementation notes
- API request logs record method, path, and status per key.
- Automation logs capture each job run and result.
- Activity logs record actions with an actor and message.
#Limitations
Known limitations
- Activity logging focuses on tracked actions, not every low-level event.
- Runtime metrics beyond these signals are not exposed in-app.
#Security considerations
Security
- Logs can contain operational detail — keep them admin-only.
- Do not log secrets or full payloads.
- Treat status endpoints as privileged.
#Best practices
- Check dependency status first when diagnosing.
- Review automation logs after important runs.
- Alert on repeated failures in request or delivery logs.
#Related documentation
Still need help?
Can’t find what you’re looking for? The DevSphere OS team is happy to help.
Was this page helpful?