Health check

Standard endpoint for health checks

Aidbox serves REST health check endpoint GET /health to configure liveness, readiness and startup probes. The response format is described by RFC (Health Check Response Format for HTTP APIs):
Request
GET /health
Response
Response
1
status: pass
2
description: health of aidbox
3
about:
4
  version: '2210'
5
  channel: edge
6
  commit: 444950a51
7
  zen-fhir-version: 0.5.21-14
8
  timestamp: '2022-10-06T13:43:45Z'
9
checks:
10
  uptime:
11
    - componentType: system
12
      observedValue: 1316
13
      observedUnit: s
14
      status: pass
15
      time: '2022-10-06T14:00:50.886Z'
16
  memory:utilization:
17
    - componentType: system
18
      status: pass
19
      observedValue: 176
20
      observedUnit: Mb
21
  db:responseTime:
22
    - status: pass
23
      componentType: database
24
      observedValue: 2
25
      observedUnit: msM
Logging /health endpoint request
By default /health endpoint requests are logged. To disable it use BOX_LOGGING_DISABLE__HEALTH__LOGS ENV variable.

X-Audit header

Next - App development

Administration

Last modified 4mo ago