hngprojects / hng_boilerplate_nestjs

Description
Apache License 2.0
181 stars 105 forks source link

[FEAT]: Implement Endpoint for Status API #1123

Open B-Beth opened 3 weeks ago

B-Beth commented 3 weeks ago

Description

Develop a system that monitors status API that allows users or internal systems to check the health and operational status of the API and its associated services.

Acceptance Criteria

  1. A valid GET status request returns an OK status when the system is fully operational, with detailed information about the health of services.
  2. The system returns appropriate statuses and detailed error messages if any service is degraded or unavailable.
  3. Security measures are in place to restrict access to the status endpoint

Purpose

Allow users to update the details of an existing language, such as the name or code, by its unique ID.

Requirements

  1. Implement the GET status endpoint to return the operational status of the API and its related services the endpoint should provide information such as: API health status, Uptime duration, Status of key services e.t.c.
  2. Implement error handling to log and report any service failures or degraded performance.
  3. Ensure that the status endpoint is protected with appropriate authentication to prevent unauthorized access.
  4. Ensure the endpoint is lightweight and does not put undue strain on system resources.
  5. Implement thorough unit and integration tests to simulate various failure scenarios

Expected Outcome

  1. The endpoint is secure and only accessible to authorized users.
  2. The API status endpoint provides real-time information about the system's health and performance.
  3. Alerts are triggered for degraded or down statuses to notify relevant teams.

Bethislearning commented 3 weeks ago

https://github.com/hngprojects/hng_boilerplate_csharp_web/pull/347