Quando necessário, o JSON de retorno dos serviços de descoberta deverão possuir uma lista com a estrutura de informações dos itens que foram avaliados pelo TOTVS Discovery.
Esta estrutura deve seguir conforme descrito abaixo:
Atributo | Tipo | Descrição | Obrigatório? | Valores |
---|---|---|---|---|
code | String | Código/Chave do item avaliado. | Sim | |
message | String | Breve descrição do item avaliado. | Sim | |
detail | String | Detalhes do item avaliado. | Não | |
status | Boolean | Situação do item avaliado. | Sim |
|
Quando necessário, o JSON de retorno de qualquer um dos serviços descritos neste documento deverá possuir uma lista com a estrutura de informações de saúde da informação retornada.
Esta estrutura deve seguir conforme descrito abaixo:
Atributo | Tipo | Descrição | Obrigatório? | Valores |
---|---|---|---|---|
type | String | Tipo da informação da situação encontrada. | Sim |
|
message | String | Breve mensagem sobre a situação encontrada. | Sim | |
detail | String | Detalhes sobre a situação encontrada. | Não | |
helpUrl | String | Página de ajuda sobre a situação encontrada. | Não |
GET /discovery/v1/resources/{id}?category=[category]
O método GET /discovery/v1/resources
é utilizado para a descoberta dos recursos (nós) que serão exibidos no Dashboard do TOTVS Discovery para avaliação de performance e saúde de cada um destes. Este método permite receber via PathParam
o id
do recurso que deseja-se retornar, caso não informado este id
, serão retornados todos os recursos descobertos. É possível também filtrar pela categoria dos recursos, se informado o filtro category
via QueryParam
, o serviço deverá filtrar os recursos descobertos retornando apenas os recursos da categoria filtrada.
No JSON de retorno, no atributo items
, deve constar as seguintes informações:
Atributo | Tipo | Descrição | Obrigatório? | Valores |
---|---|---|---|---|
id | String | ID do nó descoberto. | Sim | |
category | String | Categoria do nó descoberto. | Sim |
|
host | String | IP ou domínio do nó descoberto. | Sim | |
port | Numeric | Porta do nó descoberto. | Sim | |
info | Array | Lista com a estrutura com as informações dos itens avaliados. | Não | |
health | Array | Lista com a estrutura com as informações de saúde do nó descoberto. | Não |
{ "total": 2, "hasNext": false, "items": [{ "category": "machine", "id": "81645a9a7b2f469a89331db5a35c22d4", "host": "10.1.1.1", "port": 1234, "info": [{ "code": "cpu", "title": "CPU", "detail": "Unidade Central de Processamento", "status": true|false }], "health": [{ "type": "success|warning|error|danger", "message": "Consumo de CPU em 80%", "details": "O alto consumo da CPU do servidor prejudica o desempenho do sistema", "helpUrl": "http://www.tdn.totvs.com.br" }, { "type": "success|warning|error|danger", "message": "Memória disponível no servidor abaixo da recomendada", "details": "O recomendado para o uso do TOTVS Microsiga Protheus é de no mínimo 8gb de RAM", "helpUrl": "http://www.tdn.totvs.com.br" }] }] } |