Health-endpoints on APIs
Description
Simpl-Open's development lifecycle shall implement health-check endpoints on APIs to ensure the system’s health status can be monitored and failures can be detected early.
SMART Breakdown
- Specific: Simpl-Open must expose health-check endpoints (e.g., /health, /status) that return the current health of the system and its components, such as database connection status, service availability, etc.
- Measurable: Measured by availability percentage, response time for health checks, and the ability to detect failures early using these endpoints in automated monitoring systems.
- Achievable: Achieved by implementing health-check endpoints in the APIs, returning HTTP status codes and system metrics (e.g., response times, resource utilisation).
- Realistic: Health endpoints are a standard practice to monitor and detect potential issues in real-time, ensuring system reliability.
- Timely: Implemented as part of the initial API design, with ongoing monitoring through tools like Kubernetes, Prometheus, or CloudWatch to verify system health.
Detailed Non-Functional Requirement | Issue ID: SIMPL-9933 | Status: Proposed |