Skip to main content

Metrics & Health

Endpoints

EndpointPurpose
/api/healthLiveness — lightweight checks (always-ok, env shape, DB ping, Redis)
/api/health/readyReadiness — includes external provider pings; set CI_OFFLINE=true to skip
/metricsPrometheus — default metrics via prom-client

See backend implementation:

  • apps/access-control/access-control-backend/src/main.ts
  • apps/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:

HeaderDescription
x-app-image, x-container-imageContainer image name
x-image-digest, docker-content-digestImage digest
x-release, x-app-versionRelease version

Provide any of these env vars in the backend deployment to populate headers:

CategoryEnvironment Variables
ImageAPP_IMAGE, CONTAINER_IMAGE, IMAGE, APP_IMAGE_REGISTRY, APP_TAG
DigestAPP_IMAGE_DIGEST, IMAGE_DIGEST, CI_IMAGE_DIGEST
ReleaseAPP_RELEASE, GIT_SHA, CI_COMMIT_SHA, CI_COMMIT_TAG, CI_COMMIT_SHORT_SHA
VersionAPP_VERSION, VERSION