Objetivo

Definições Gerais

Estrutura com informações de saúde

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	sucess: Sucesso (OK) warning: Alerta/Aviso error: Erro \| Com contorno danger: Erro Fatal/Sem contorno
`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

Serviços

Serviço de descoberta de recursos (nós) aptos para avalição através do TOTVS Discovery.

GET /discovery/v1/resources

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.

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	server: Servidor de Aplicação machine: ??? database: Banco de Dados lsv: Servidor de Licenças gateway: ???
`host`	`String`	IP ou domínio do nó descoberto.	Sim
`port`	`Numeric`	Porta do nó descoberto.	Sim
`health`	`Array`	Estrutura com as informações de saúde do nó descoberto.	Sim

Exemplo JSON de retorno

{
	"total": 10,
	"hasNext": false,
	"items": [{
		"category": "machine|server|database|lsv|gateway",
		"id": "81645a9a7b2f469a89331db5a35c22d4",
		"host": "10.1.1.1",
		"port": 1234,
		"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"
		}]
	}]
}