Quick navigation
API Healthcheck endpoints
Liveness endpoint
/platform/api/modules/health/live
Return a status 200 when platform-api http server is up.
Curl example :
$ curl -s http://localhost:8080/platform/api/modules/health/live | jq .
#"Ok"
Could be used to setup probes on kubernetes or docker-compose.
docker-compose probe setup
healthcheck:
test:
[
'CMD-SHELL',
'curl --fail http://localhost:${CDK_LISTENING_PORT:-8080}/platform/api/modules/health/live',
]
interval: 10s
start_period: 120s # Leave time for the psql init scripts to run
timeout: 5s
retries: 3
Kubernetes liveness probe
Port configuration
ports:
- containerPort: 8080
protocol: TCP
name: httpprobe
Probe configuration
livenessProbe:
httpGet:
path: /platform/api/modules/health/live
port: httpprobe
initialDelaySeconds: 5
periodSeconds: 10
timeoutSeconds: 5
Readyness/startup endpoint
/platform/api/modules/health/ready
Return readiness of the platform and each module. Modules status :
STARTING
(initial state)UP
DOWN
DISABLED
(disabled modules by license or manually)
This endpoint return 200 statusCode if all modules are in UP
or DISABLED
state.
Otherwise, return 503 ("Service Unavailable") if at least one module is in STARTING
or DOWN
state.
Curl example :
$ curl -s http://localhost:8080/platform/api/modules/health/ready | jq .
#{
# "authenticator": "DOWN",
# "console": "UP",
# "testing": "DISABLED",
# "monitoring": "UP",
# "topic_analyzer": "DISABLED",
# "governance": "UP",
# "is_ready": true
#}
Kubernetes startup probe
Port configuration
ports:
- containerPort: 8080
protocol: TCP
name: httpprobe
```yaml
startupProbe:
httpGet:
path: /platform/api/modules/health/ready
port: httpprobe
initialDelaySeconds: 30
periodSeconds: 10
timeoutSeconds: 5
failureThreshold: 30
Console Information
Console versions
/platform/api/modules/versions
This endpoint expose module versions used to build the Console along with the overall Console version.
Curl example :
curl -s http://localhost:8080/platform/api/modules/versions | jq .
# {
# "platform": "main-5709b4018926a09601087ace83483ebf137a8c77",
# "console": "b5204df2bf9511996f05b3f01344924e9378ae5e",
# "console_web": "c67f454eaf7e9331f9992ebd4433a75b82156e2a-staging",
# "governance_api": "0.50.9",
# "authenticator": "1.7.0",
# "monitoring": "0.64.0",
# "testing_api": "0.39.0",
# "testing_agent": "0.38.0"
# }