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:8027/actuator/health, 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:8027/actuator/health

O resultado deve ser similar ao seguinte:

$ 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"
      }

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

asrEngine.status

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

asrEngine.details.version

Indica a versão do motor ASR.

grpcChannel.status

Indica que o canal da interface GRPC está operacional (“UP”).

licenseManager.status

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

asrEngine.licenseStatus

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

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.