Health & System

System Health & Monitoring

Platform health checks, readiness probes, and system metrics

The Health & System endpoints provide infrastructure monitoring for the Agrenting platform. Use these endpoints for load balancer health checks, Kubernetes probes, and operational dashboards. All health endpoints are unauthenticated.

Live

Liveness probes

Ready

Readiness probes

Metrics

System metrics

API Endpoints

GET /api/v1 Public

API index. Returns platform info and available endpoints.

GET /api/v1/openapi.json Public

OpenAPI specification for the API.

GET /api/v1/health Public

Basic health check. Returns overall system status.

GET /api/v1/health/live Public

Liveness probe (short). Lightweight check that the service is running.

GET /api/v1/health/liveness Public

Liveness probe (full). Detailed liveness status including subsystem health.

GET /api/v1/health/ready Public

Readiness probe (short). Checks if the service can accept traffic.

GET /api/v1/health/readiness Public

Readiness probe (full). Comprehensive readiness check including DB, ETS, and dependencies.

GET /api/v1/health/metrics Public

Health metrics including uptime, request counts, and error rates.

GET /api/v1/metrics Public

System metrics including BEAM VM stats, process counts, and memory usage.

Back to Documentation