Health Check API¶
The ASR server provides a health check API, by means of a HTTP request to URL http://ASR_HOST:8081/healthcheck, where ASR_HOST is the IP of the ASR Server to be checked.
As an example, open a console on the ASR Server machine and run:
curl http://localhost:8027/actuator/health
The result should be something like this:
$ curl http://localhost:8027/actuator/health
Health Check:
{
"components": {
"asrEngine": {
"details": {
"licenseStatus": "ONLINE",
"version": "3.8.0"
},
"status": "UP"
},
"diskSpace": {
"details": {
"exists": true,
"free": 171307741184,
"threshold": 10485760,
"total": 269490393088
},
"status": "UP"
},
"grpcChannel": {
"status": "UP"
},
"licenseManager": {
"status": "UP"
},
"ping": {
"status": "UP"
}
},
"status": "UP"
}
The main fields of the returned JSON are explained below:
asr-engine.message
Indicates that the ASR engine was successfully loaded (‘true’).
asr-engine.message
Indicates the ASR server and engine versions.
grpcChannel.status
Indicates that the GRPC interface channel is operational (‘UP’).
license-manager-visibility.healthy
Indicates that the license server is accessible (‘UP’).
asr-engine.message
Indicates that the license control is working properly (‘true’).
Details regarding the ASR license control status.
ONLINE: Working. The ASR server can perform recognitions.
OFFLINE: ASR server is operating in off-line mode and is performing recognitions temporarily. Check the connectivity between the ASR server and the license server. If the problem persists, after working off-line for a period, the ASR server will no longer do recognitions.
BLOCKED: The ASR server has been blocked due to license issues. Details regarding the block is also returned in this field. In this status, the ASR server will not perform recognitions.
UNEXPECTED_STATE: The ASR server found an unexpected error. Its ability to do recognitions might be affected.