DocumentaciónAjuda

Monitorar uma API com etapas e variáveis

Monte um monitoramento composto de uma API com autenticação do cofre, várias etapas que passam variáveis entre si, validações JSON e métricas próprias.

Nesta página

Um monitoramento de API executa uma ou várias requisições em ordem, como o seu sistema faria: faz login, captura um dado da resposta, usa-o na requisição seguinte e valida cada resultado. Ele pode mostrar em gráfico valores numéricos das respostas e alertar com limites.

Antes de começar

  • Você precisa de permissão para operar em Aplicações.

  • Os tokens, senhas e certificados são guardados no cofre. Um administrador os cria em Configurações → Monitoramento → Credenciais.

Passo 1: dados gerais

  1. Entre em Aplicações → WebServices e clique em Adicionar WebService (ou Editar em um existente).

  2. Digite o Nome e, se quiser, escolha o Grupo (opcional).

O formulário tem as abas Requisição, Autenticação, Validações, Etapas, Métricas e Onde roda. Quando há mais de uma etapa, em Requisição e Validações você escolhe no topo a qual etapa corresponde o que está editando.

Passo 2: a requisição

Em Requisição:

  1. Escolha o Método e digite a URL.

  2. Adicione Parâmetros e Headers com Adicionar parâmetro e Adicionar header.

  3. Para métodos com corpo, escolha o Tipo de Corpo: Sem corpo, JSON, Formulário ou Texto. Se o JSON não for válido, o formulário avisa.

  4. Em Opções, ajuste o Tempo limite (s) (1 a 60), Seguir redirecionamentos e Verificar o certificado TLS.

  5. Confira a Pré-visualização da requisição.

Não coloque tokens nem senhas nos headers nem nos parâmetros: use a aba Autenticação. Um método que altera dados (POST, PUT, PATCH, DELETE) é executado em cada verificação; ao salvar, pede-se confirmação.

Passo 3: a autenticação (login, token ou OAuth2)

Em Autenticação:

  1. Em Credencial, escolha uma do cofre. Podem ser:

    • Token de API (em um header ou parâmetro, com prefixo).

    • Usuário e senha (Basic).

    • OAuth2.

    • Token obtido de outra API (um login anterior).

  2. Opcional: escolha um Certificado de cliente (mTLS).

  3. Se houver várias etapas, marque em Etapas que usam a autenticação quais a levam.

Os segredos nunca são mostrados nem ficam nos resultados.

Passo 4: as etapas e as variáveis

Em Etapas:

  1. Clique em Adicionar etapa (até 10). Dê um nome a cada uma.

  2. Com os botões de cada etapa você pode editar a requisição dela, subi-la, descê-la, duplicá-la ou removê-la.

  3. Em Variáveis que captura, clique em Capturar variável e defina:

    • O nome da variável, por exemplo token ou pedido.

    • De onde ela vem: Caminho JSON (por exemplo $.data.id), Header (por exemplo Location) ou Expressão regular.

    • Secreta, se não deve ser mostrada nem guardada.

  4. Use a variável nas etapas seguintes escrevendo o nome dela entre chaves duplas, por exemplo {{pedido}}, na URL, nos headers, nos parâmetros ou no corpo.

Se uma etapa usar uma variável que nenhuma etapa anterior captura, o formulário avisa.

Passo 5: as validações

Em Validações, escolha o tipo e clique em Adicionar validação:

Tipo

O que compara

Código HTTP

Os códigos esperados, como 200, 200-299 ou 2xx.

Tempo de resposta

Aviso e crítico em milissegundos.

Header

Que um header existe, não existe, é igual a ou contém um valor.

Corpo (texto ou expressão)

Que o corpo contém, não contém, corresponde à expressão ou não corresponde à expressão.

Valor JSON por caminho

Que o valor em um caminho (por exemplo $.data.status) existe, não existe, é igual a, é diferente de, é maior que, é menor que ou contém.

Cada validação é Crítica ou de Aviso. Uma crítica deixa o serviço fora do ar e interrompe as etapas seguintes; uma de aviso o deixa em advertência. Todas precisam ser cumpridas.

Passo 6: as métricas

Em Métricas, mostre em gráfico valores numéricos capturados nas etapas:

  1. Clique em Adicionar métrica (até 10).

  2. Escolha a variável (não secreta), digite o nome (por exemplo Pedidos pendentes) e a unidade.

  3. Escolha Alerta se subir de ou Alerta se baixar de e digite o aviso e o crítico.

A latência de cada etapa sempre aparece no gráfico.

Passo 7: onde roda, testar e salvar

  1. Em Onde roda, escolha Verificar a partir de. Veja Escolher a partir de onde é verificado.

  2. Clique em Testar agora. Abaixo aparece Resultado de “Testar agora” com o status, a latência e o detalhe de cada etapa.

  3. Clique em Salvar. Se faltar algo, o formulário lista antes de salvar.

Relacionado

Pesquisar em Argunis Monitoring

Digite pelo menos 2 letras para pesquisar em Argunis Monitoring.

↑↓ navegar · Enter abrir · Esc fechar