API de health check

O Servidor CPqD ASR disponibiliza uma API para verificação de bom funcionamento (health check) através de uma requisição HTTP para a URL http://ASR_HOST:8081/healthcheck, onde ASR_HOST é o IP do Servidor ASR desejado.

Para exemplificar, abra um console na máquina do Servidor ASR e execute o comando:

curl http://localhost:8081/healthcheck?pretty=true

O resultado deve ser similar ao seguinte:

$ curl http://localhost:8081/healthcheck?pretty=true

{
  "asr-engine" : {
    "healthy" : true,
    "message" : "CPqD ASR Server: 2.6.0 [Engine: 3.2.0]"
  },
  "deadlocks" : {
    "healthy" : true
  },
  "direct-memory" : {
    "healthy" : true,
    "message" : "directMemoryUsed: 72.13429832458496 MB, totalCapacity: 72.13429832458496 MB, maxDirectMemory: 512.0 MB"
  },
  "license-manager-visibility" : {
    "healthy" : true
  },
  "license-status" : {
    "healthy" : true,
    "message" : "ONLINE"
  }
}

Os principais campos do JSON retornado são explicados a seguir:

asr-engine.healthy

Indica que o motor ASR foi carregado com sucesso (“true”).

asr-engine.message

Indica as versões do servidor e motor ASR.

license-manager-visibility.healthy

Indica que o servidor de licença está acessível (“true”).

license-status.healthy

Indica que o controle da licença está funcionando corretamente (“true”).

license-status.message

Detalhamento do estado do controle da licença do ASR.

• ONLINE: Funcionamento normal. O servidor ASR pode realizar reconhecimentos.

• OFFLINE: Servidor ASR está operando em modo offline e está temporariamente realizando reconhecimentos. Verifique a conectividade entre o servidor ASR e o servidor de licenças. Se o problema persistir, depois do tempo de operação offline, o servidor ASR não realizará mais reconhecimentos.

• BLOCKED: Servidor ASR foi bloqueado por causa da licença. Detalhe do bloqueio também é retornado neste campo. Neste estado, o servidor ASR não realiza reconhecimentos.

• UNEXPECTED_STATE: Servidor ASR encontrou um erro inesperado. A capacidade de realizar reconhecimentos pode ser afetada.