Metrics & Health
Endpoints
| Endpoint | Purpose |
|---|---|
/api/health | Liveness — lightweight checks (always-ok, env shape, DB ping, Redis) |
/api/health/ready | Readiness — includes external provider pings; set CI_OFFLINE=true to skip |
/metrics | Prometheus — default metrics via prom-client |
See backend implementation:
apps/access-control/access-control-backend/src/main.tsapps/access-control/access-control-backend/src/app/health/health.controller.ts
Admin UI "k8s Sync Status"
The admin UI reads headers from /api/health/ready to display image/tag/release:
| Header | Description |
|---|---|
x-app-image, x-container-image | Container image name |
x-image-digest, docker-content-digest | Image digest |
x-release, x-app-version | Release version |
Provide any of these env vars in the backend deployment to populate headers:
| Category | Environment Variables |
|---|---|
| Image | APP_IMAGE, CONTAINER_IMAGE, IMAGE, APP_IMAGE_REGISTRY, APP_TAG |
| Digest | APP_IMAGE_DIGEST, IMAGE_DIGEST, CI_IMAGE_DIGEST |
| Release | APP_RELEASE, GIT_SHA, CI_COMMIT_SHA, CI_COMMIT_TAG, CI_COMMIT_SHORT_SHA |
| Version | APP_VERSION, VERSION |