Monitorar os valores de uma API JSON
Consulte a API de um host (por exemplo, os suprimentos de uma impressora), veja o JSON dela e escolha com um clique os valores monitorados, cada um com sua métrica e seus limites.
Muitos hosts têm uma API que responde em JSON: impressoras (níveis de tinta ou toner), nobreaks, controladoras, sistemas próprios. Um teste API JSON consulta essa API, pega os valores que você escolher e os deixa como métricas do dispositivo: com seu gráfico e seu status na ficha do host em Infraestrutura, como qualquer outro monitoramento.
Antes de começar
Você precisa de Administrar em Plugins para criar o teste e de Operar para associá-lo a um host.
A consulta é feita pela sonda de monitoramento (3.3.0 ou superior) que monitora o host. Ele só é associado a hosts monitorados por uma sonda; o agente de um servidor e a nuvem do ARGUNIS não o executam.
Se a API pedir um token ou usuário e senha, crie-os antes no cofre (Configurações → Monitoramento → Credenciais). Eles nunca são escritos no teste.
Passos
Entre em Configurações → Monitoramento → Testes de monitoramento e clique em Novo teste.
Digite o Nome (por exemplo, «Impressora HP · tintas»).
Em Plugin, escolha API JSON: consultar um JSON e escolher seus valores (sempre executado por uma sonda).
Em URL da API, digite o endereço com as macros do dispositivo, por exemplo
https://$HOSTADDRESS$/cdm/supply/v1/suppliesPublic. Assim o mesmo teste serve para todas as impressoras desse modelo.Se o host usar um certificado próprio (o normal em impressoras), marque Aceitar certificado próprio do host.
Em Consultar, procure um Dispositivo de exemplo monitorado por uma sonda (e escolha a Credencial, se a API pedir) e clique em Consultar: quem faz o pedido é a sonda desse dispositivo.
Você verá o JSON da API. Ao lado de cada valor numérico, clique em Monitorar: ele é adicionado à tabela de Valores monitorados com um nome, sua métrica e seu caminho.
Na tabela, ajuste o Nome, a Unidade, se ele alerta quando o valor fica abaixo de ou fica acima de, e os limites de Aviso e Crítico. Por exemplo, uma tinta: «fica abaixo de», aviso 20 e crítico 10.
Clique em Salvar.
Depois, associe-o aos hosts pela ficha deles (Adicionar do catálogo) ou com uma Criar uma tag de monitoramento.
Em uma lista (por exemplo, a lista de suprimentos), o ARGUNIS procura o elemento pelo conteúdo e não pela posição: o caminho fica como suppliesList[supplyType=inkTank, supplyColorCode=K].percentLifeDisplay (o tanque de tinta preta). Se o host mudar a ordem da lista, o valor continua sendo encontrado.
O que acontece depois
Cada valor é uma métrica do monitoramento na ficha do host, com seu gráfico.
O status do monitoramento é o pior dos seus valores. Se a API não responder, não devolver JSON ou faltar um valor, ele fica em crítico e o texto diz por quê.
Até 20 valores por teste, uma resposta de até 1 MB e um intervalo de pelo menos 30 segundos.
As requisições POST, PUT, PATCH e DELETE podem alterar dados no host: é preciso confirmá-las ao salvar.