API de Health Check¶

As interfaces REST e Websocket permitem usar o CPQD Texto Fala disponibiliza uma API para verificação de bom funcionamento (health check) através de uma requisição HTTP para a URL http://localhost:9091/healthcheck.

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

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

O resultado deve ser similar ao seguinte:

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

{
  "deadlocks" : {
    "healthy" : true
  },
  "license-manager-visibility" : {
    "healthy" : true
  },
  "tts-remaining-time" : {
    "healthy" : true,
    "message": "00:12:30"
  },
  "tts-engine-version" : {
    "healthy" : true,
    "message": "CPqD TTS Server: 3.3.11 [Engine: 4.7.0]"
  },
  "tts-engine-status" : {
    "healthy" : true,
    "message" : "ONLINE"
  }
}

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

tts-remaining-time.message

Indica o tempo de operação quando o sistema está OFFLINE.

tts-engine-version.message

Indica as versões do servidor e da engine do CPqD Texto Fala.

license-manager-visibility.healthy

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

tts-engine-status.healthy

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

tts-engine-status.message

Detalhamento do estado do controle da licença do CPqD Texto Fala.

ONLINE: Funcionamento normal. O servidor do CPqD Texto Fala pode realizar sínteses.

OFFLINE: Servidor do CPqD Texto Fala está operando em modo offline e está temporariamente realizando sínteses. Verifique a conectividade entre o servidor do CPqD Texto Fala e o servidor de licenças. Se o problema persistir, depois do tempo de operação offline, o servidor do CPqD Texto Fala não realizará mais sínteses.

BLOCKED: Servidor do CPqD Texto Fala foi bloqueado por causa da licença. Detalhe do bloqueio também é retornado neste campo. Neste estado, o servidor do CPqD Texto Fala não realiza sínteses.

UNEXPECTED_STATE: Servidor do CPqD Texto Fala encontrou um erro inesperado. A capacidade de realizar sínteses pode ser afetada.