Add HealthCheck API route for system status monitoring

We are adding a HealthCheck route to our API, allowing users to check if the API is online and retrieve additional system health insights. This endpoint will help developers monitor uptime, diagnose issues, and get real-time status updates.

🔹 Why?

• Allows users to confirm API availability before making requests.

• Provides key system health metrics to help with debugging.

• Improves developer experience by reducing downtime-related confusion.

• Ensures internal monitoring tools can track API status in real-time.

🔹 How it works?

• Create a /health or /status route in the API.

• Return a JSON response with:

{ "status": "ok", "uptime": 86400, "database": "connected", "elasticsearch": "operational", "requests_last_minute": 120, "api_version": "v1.4.0" }

• Include checks for:

API uptime

Database connection status

Elasticsearch or caching service health

Recent request volume

Current API version

• Implement tests to ensure HealthCheck always returns accurate data.

Document the endpoint in the API documentation, including response examples.

• Optionally, integrate with monitoring tools like Datadog or Prometheus for deeper insights.

Please authenticate to join the conversation.

Upvoters
Status

In Review

Board
💡

Features & Integrations

Date

12 months ago

Author

Julien Le Coupanec

Subscribe to post

Get notified by email when there are changes.