Integrações

Páginas filhas
  • TOTVS Discovery

Versões comparadas

Versão antiga 8

changes.mady.by.user Usuário desconhecido (rubens.santos)

Gravado em

comparado com

Nova versão 9

changes.mady.by.user Usuário desconhecido (rubens.santos)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

AtributoTipoDescriçãoObrigatório?Valores
codeStringCódigo/Chave do item avaliado.Sim
messageStringBreve descrição do item avaliado.Sim
detailStringDetalhes do item avaliado.Não
statushealth
BooleanSituação do item avaliado.SimArrayLista com a estrutura com as informações de saúde do nó descoberto.Não
  • true: verdadeiro se o item avaliado não apresentou inconformidades
    • false: falso se o item avaliado apresentou inconformidades


    Estrutura com informações de saúde
    Âncora
    health_struct
    health_struct

    ...

    GET /discovery/v1/resources/{host}/{port}/{category}/{idname}?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.

    ...

    Lista com a estrutura com as informações de saúde do nó descoberto
    AtributoTipoDescriçãoObrigatório?Valores
    idStringID do nó descoberto.Sim
    categoryStringCategoria do nó descoberto.Sim
    • server: Servidor de Aplicação
    • machine: ???
    • database: Banco de Dados
    • lsv: Servidor de Licenças
    • gateway: ???
    hostStringIP ou domínio do nó descoberto.Sim
    portNumericPorta do nó descoberto.Sim
    infoArrayLista com a estrutura com as informações dos itens avaliados.NãohealthArray.Não

    Exemplo JSON de retorno

    Bloco de código
    languagejs
    {
	"total": 2,
	"hasNext": false,
	"items": [{
		"category": "machine",
		"id": "81645a9a7b2f469a89331db5a35c22d4",
		"host": "10.1.1.1",
		"port": 1234,
        "name": "PROTHEUS_V12_PROD",
		"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"
			}]
		}]
	}]
}