API Health Monitoring

The API health dashboard provides real-time visibility into the status and performance of AcaTrove's backend services. Administrators can monitor endpoint availability, response times, error rates, and overall system health. Admin role is required.

Accessing API Health

Navigate to /admin/api-health from the admin sidebar. The dashboard auto-refreshes every 30 seconds to provide near-real-time data.

API health dashboard with endpoint status and response time metrics

Dashboard Overview

The API health page displays several key indicators:

System Status -- An overall health indicator (Healthy, Degraded, or Down) based on the aggregate status of all endpoints. A green status means all monitored endpoints are responding within acceptable thresholds.

Backend Connectivity -- The connection status between the Next.js frontend and the FastAPI backend. This is the most fundamental health check, as all AI features and data operations depend on backend connectivity.

Endpoint Status Table -- A list of all monitored endpoints showing:

• Endpoint path and HTTP method.
• Current status (Up, Slow, Error, Down).
• Average response time over the last hour.
• Error rate (percentage of requests returning 4xx or 5xx status codes).
• Last successful response timestamp.

Response Time Metrics

Each endpoint includes a response time chart showing performance over time. Response times are color-coded:

• Green (under 500ms) -- Normal performance.
• Yellow (500ms to 2 seconds) -- Slower than ideal but functional.
• Red (over 2 seconds) -- Performance degradation that may affect user experience.

Use these charts to identify performance trends and correlate slowdowns with specific events (deployments, high traffic, database issues).

Error Tracking

The error tracking section shows recent API errors across all endpoints:

• Error timestamp, endpoint, and HTTP status code.
• Error message and stack trace (when available).
• Frequency -- how often this error has occurred in the last 24 hours.

Click on any error to see its full details. Recurring errors are grouped and highlighted for attention.

Health Check Endpoints

AcaTrove includes dedicated health check endpoints that the dashboard monitors:

• /api/health -- Frontend health check.
• /api/v1/health -- Backend health check.
• /api/v1/health/db -- Database connectivity check.
• /api/v1/health/redis -- Redis connectivity check.

These endpoints return basic status information and are designed to respond quickly even when the system is under load.

Alerts

Configure alerts to be notified when health issues arise:

1. Click Configure Alerts on the API health page.
2. Set conditions for alerts:
   • Any endpoint is down for more than N minutes.
   • Average response time exceeds a threshold.
   • Error rate exceeds a percentage.
3. Choose notification channels (in-app, email).
4. Click Save.

Tips

• Check the API health dashboard after deployments to verify that all endpoints are responding correctly.
• If you see elevated response times for AI-related endpoints, check the RAG Analytics page for related issues.
• Use the error tracking section to identify patterns -- recurring 500 errors often indicate a backend bug rather than a transient issue.
• Share the health dashboard URL with your IT team if they need to monitor AcaTrove's infrastructure.