General Trace

O General Trace é um recurso importante para a checagem e monitoração de calls que são realizadas pelas Apps às APIs e que são gerênciadas pelo Manager. Essa seção pode ser acessada através do menu lateral, clicando no ícone General Trace. Nesta página é possível visualizar uma lista com todas as chamadas já realizadas. Podemos também filtrá-las e até exportá-las em um arquivo no formato ".json".

O conteúdo dessa listagem passa por uma filtragem no qual leva em consideração a configuração do environment, chamada de Environment Trace Visibility. Está configuração irá somente exibir na listagem as calls nos quais o usuário tem acesso. Para confirmar quais são os environments que determinado usuário tem acesso, basta clicar no link presente acima da contagem chamados: Only the calls to allowed environments are displayed.

A tela principal de listagem de calls possui paginação e também contém opção de escolha da quantidade de registros que serão mostrados por página, que podem ser 10, 25, 50 ou 100 registros, para facilitar a navegação.

Filtros de listagem do General Trace

A listagem inicial de calls possui dois tipos de filtros para simplificar a busca por registros:

  • URI: As calls listadas serão filtradas de acordo com o campo "URI" cadastrado em uma API. Esse é o mesmo endereço utilizado para fazer requisições a uma API;

  • Time: Constituído por dois campos (Begin e End) que tem a função de trazer informações de acordo o período de tempo desejado. O filtro pode ser ser configurado indicando um limite de dias e horas para ser pesquisado;

  • HTTP Response: Filtro que possibilita pesquisar chamadas às APIs que retornaram sucesso (de HTTP 200 até 399), bloqueio (HTTP 413 ou 429), erro de cliente (de HTTP 400 até 499, com exceção de 413 e 429) e erro de servidor (de HTTP 500 até 599).

Para aplicar os filtros e listar apenas as calls relacionadas, clique no botão SEARCH. E para limpar os filtros selecionados, use o botão CLEAR. Nesta opção, os filtros serão limpos e uma nova pesquisa será feita trazendo todas as chamadas sem restrição.

OBS: Quando os filtros são selecionados, eles funcionam em ação conjunta e o filtro Time traz registros em um intervalo de 14 dias.

Custom Search

Na aba Custom Search é possível realizar buscas de chamadas de maneira personalizada com a passagem de parâmetros especiais, visando buscar chamados mais específicos na listagem do trace.

O Custom Search utiliza sintaxe e índices do Lucene para realizar as pesquisas. Para saber quais são os parâmetros aceitos, consultar o Dicionário de Dados presente nesta documentação.

Para realização de consultas, insira uma Query valida no campo Custom Search e clique no botão Search.

Na imagem acima, temos a pesquisa por chamados que contenham o ID da API com valor 3, e chamados ocorridos no mês de Março para o ano de 2017.

Para limpar o campo e realizar outra chamada, clique no botão Clear.

OBS: A aba Filters e a aba Custom funcionam de maneira independente, ou seja, não é possível utilizar os filtros juntamente com uma Query de Custom Search para realizar as pesquisas.

Inspeção de Calls

Os itens presentes na listagem de calls do General Trace podem ser inspecionados para obter maiores detalhes de uma call específica, clicando em sua URI.

Esta tela contém duas abas: OVERVIEW e GATEWAY TRACE. Para sair desta tela, clique no botão BACK no final da página.

  • OVERVIEW: Apresenta informações gerais sobre a chamada de forma muito mais detalhada.

  • GATEWAY TRACE: Exibe o Log do Gateway no momento em que a chamada foi realizada. Está seção pode ser utilizada como ferramenta de auditoria, análise ou manutenção.

Clicando no ícone de lupa em Details na mesma linha do item desejado, alguns passos do Gateway podem ser mais detalhados. Então, um popup será exibido com as informações.

Mas, para obter esse nível de detalhamento, é fundamental que sua API possua interceptores de Log cadastrados. OBS: Caso o interceptor de Log tenha a configuração de Encrypt Content ativo, os detalhes serão, por padrão, bloqueados, podendo ser disponibilizados mediante permissão.

Export General Trace

Exporta todas as calls da lista que está sendo exibida. Se for utilizado um filtro, será exportado apenas as calls que foram consultadas com o filtro utilizado. Este botão está localizado no início da listagem de calls.