Registros da API¶

Introdução¶

A página API Logs no API Manager exibe uma tabela de todos os logs de processamento da API, bem como logs de depurar (se o log de depurar estiver ativado). Os logs são exibidos para APIs personalizadas, OData e proxy quando são chamados por meio do Gateway de API em Nuvem ou Gateway de API Privado.

Existem quatro tipos de logs que podem ser registrados para uma chamada de API:

• Logs de API: Os logs de API são gerados automaticamente na página Logs de API para cada chamada de API do API Manager. Os logs da API contêm informações sobre a chamada da API, incluindo o registro de data e hora da solicitação da API, o código de status HTTP, a ID da solicitação, o método da solicitação, o URI da solicitação, o tempo de resposta, o IP de origem do aplicativo de chamada, o aplicativo de origem, e quaisquer mensagens de registro.
• Logs de depuração da API: Os logs de depurar da API são entradas adicionais em um log de API existente que rastreia totalmente todas as solicitações recebidas por meio de um URL de serviço da API do API Manager. O log de depurar da API não é ativado por padrão e deve ser ativado em uma API do API Manager individual para que os logs de depurar da API sejam incluídos em um log da API.
• API Verbose Logs: API verbose logs são entradas adicionais em um log de API existente que consiste em dados de solicitação e resposta recebidos ou enviados por meio de um URL de serviço da API do API Manager. A criação de log detalhado da API não é ativada por padrão e deve ser ativada em uma API individual do API Manager para que os logs detalhados da API sejam incluídos em um log da API.
• Logs de operação da API: Os logs de operação da API contêm o início de uma chamada de API e o tempo decorrido. Ao contrário dos logs de API, logs de depurar e logs detalhados, os logs de operação da API requerem o uso de um Agente Privado e são ativados no arquivo de configuração do Agente Privado. Esses logs são registrados no Agente Privado no jitterbit.log arquivo localizado no log diretório.

Os dados de log para logs de API, logs de depurar e logs detalhados estão disponíveis na página API Logs por 90 dias a partir da data em que a API é consumida.

Para obter mais informações sobre como habilitar logs de depurar e logs detalhados, consulte estes recursos:

• Etapa 1: Configurações de Configuração de API Customizada
• Etapa 1: Configurações de Configuração do Serviço OData
• Etapa 1: Configurações básicas de Configuração da proxy de API

Para adicionar informações de log adicionais para APIs OData, incluindo os dados SQL enviados para o banco de dados, edite o arquivo de configuração do Agente Privado E definir DebugJDML para true.

Acessando a Página de Logs da API¶

A página API Logs pode ser acessada no menu Harmony Portal ou em outras páginas do API Manager:

• Da Casa ou Downloads ou nas páginas Cloud Studio, Vinyl, Marketplace, Management Console, EDI, ou Citizen Integrator, use o menu Harmony Portal no canto superior esquerdo para acessar API Manager > API Logs:

  

• A partir das Minhas APIs, Gerenciador do Portal, Análise, Perfis de segurança, Grupos de IPs Confiáveis ou Grupos de API, use o menu de navegação do API Manager para selecionar API Logs:

  

Cabeçalho da Página de Registros da API¶

O cabeçalho na parte superior da página API Logs inclui o menu de navegação do API Manager, uma barra de pesquisa, filtros e opções adicionais:

Você pode ajustar os dados exibidos usando os menus suspensos Filtrar por e Visualizar dados.

Filtrar por¶

Os menus suspensos Filtrar por permitem que você exiba logs de API com base em critérios específicos em qualquer combinação de ambientes, APIs, perfis, códigos de status ou métodos de solicitação.

Cada filtro exibe uma lista suspensa de critérios da qual você pode selecionar um ou vários critérios.

Estes são os critérios disponíveis para filtrar:

• Ambientes: Use o menu suspenso para selecionar os ambientes onde as APIs estão localizadas. Quando todos os filtros são desmarcados, os ambientes de todas as APIs na organização à qual você tem acesso são exibidos.

• APIs: Use o menu suspenso para selecionar APIs publicadas na organização. Quando todos os filtros são desmarcados, todas as APIs na organização à qual você tem acesso são exibidas.

  Nota

  APIs publicadas anteriormente que não foram publicadas não aparecerão no menu suspenso APIs. Os logs de API para essas APIs estarão presentes na página API Logs, mas não podem ser filtrados.

• Perfis: Use o menu suspenso para selecionar os perfis de segurança atribuídos às APIs. Quando todos os filtros são desmarcados, todos os perfis de segurança na organização à qual você tem acesso são exibidos.

• Códigos de status: Use o menu suspenso para selecionar os grupos de códigos de status de resposta HTTP, selecionando entre Sucesso (2xx), Redirecionamentos (3xx), Erros do cliente (4xx), e Erros do servidor (5xx). Quando todos os filtros são desmarcados, todos os códigos de status de resposta HTTP para APIs nas organizações às quais você tem acesso são exibidos. Para obter mais informações sobre códigos de status, consulte w3.org status definições de código.

• Request Methods: Use o menu suspenso para selecionar os métodos de solicitação HTTP, selecionando GET, PUT, POST, DELETE, PATCH, e MERGE. Quando todos os filtros são desmarcados, todos os métodos de solicitação HTTP para APIs na organização à qual você tem acesso são exibidos. Para obter mais informações sobre métodos de solicitação HTTP, consulte métodos de solicitação do w3.org.

Ver Dados¶

A opção Exibir dados permite que você exiba logs dentro de um período de tempo específico. A configuração padrão para o período de tempo é Últimos 7 dias.

Use o menu suspenso Visualizar dados para selecionar o período de tempo desejado. Selecione um dos Últimos 10 minutos, Última 1 hora, Últimas 10 horas, Últimas 24 horas, Últimos 7 dias, Último 1 mês, ou Período personalizado.

Selecionar Período personalizado permite exibir logs de API em um período de tempo especificado. Quando esta opção é selecionada, os campos de calendário adicionais De e Para são exibidos:

• De: Clique para ajustar a data e hora de início dos logs da API.
• Para: Clique para ajustar a data e hora de término dos logs da API.

Depois de clicar nos campos de calendário De ou Para, uma caixa de diálogo de calendário é exibida onde você seleciona a data e a hora:

Procurando¶

A barra de pesquisa permite filtrar os logs pelos critérios de pesquisa fornecidos abaixo:

• Somente logs com mensagens: Selecione para restringir ainda mais os resultados da pesquisa apenas para logs que incluam detalhes de log. Os resultados da pesquisa serão atualizados automaticamente.

Critérios de Pesquisa¶

Estes são os critérios de pesquisa que podem ser usados. Exemplos de critérios de pesquisa válidos e inválidos estão incluídos:

Combinando Pesquisas¶

As pesquisas podem conter uma combinação de critérios. Os critérios de pesquisa combinados devem ser separados por um ponto e vírgula (;) entre cada critério. Estes são exemplos de pesquisas combinadas válidas:

message=%Access Denied%;requesturi=%contacts%;

requestid=%yzaccwui%;message=%REJECT%;
requesturi=%contacts%;responsetime<=2;
responsetime>=5;sourceapp=%Chrome%;
responsetime>=5;sourceip=70.5%;
sourceapp=%Chrome%;message=%REJECT%;

sourceapp=%Mozilla%;responsetime<=1;

sourceip=70.5%;requesturi=%contacts%;

Opções Adicionais¶

Opções adicionais de registro da API são exibidas no lado esquerdo da página, diretamente acima da barra de pesquisa:

• Visualizar última atualização: Exibe a última vez que os dados foram atualizados de forma dinâmica ou manual. A hora é exibida no formato h:mm:ss.

• Atualizar: Clique para atualizar os dados de registro com base nos filtros aplicados e nos critérios de pesquisa.

• Baixar como CSV: Clique para baixar os dados de registro atuais com base nos filtros aplicados e critérios de pesquisa.

  Nota

  O campo de data no arquivo CSV é um registro de data e hora do UNIX que exigirá conversão se você quiser usar um formato de data e hora diferente.

Como Visualizar Registros da API¶

Cada linha na tabela de logs da API exibe os dados de log da API para uma chamada de API:

• Time Stamp: O timestamp da solicitação de API. Os horários são exibidos no fuso horário do seu navegador.
• Código de status: O código de status HTTP. Para obter mais informações sobre códigos de status HTTP, consulte w3.org definições de código de status.
• ID da solicitação: Uma ID exclusiva para a solicitação da API.
• Request Method: O método de solicitação HTTP da API (GET, PUT, POST, DELETE, PATCH ou MERGE).
• Request URI: O URL completo da API que foi chamada. Passe o mouse sobre o campo Solicitar URI para ver o URL completo.
• Tempo de resposta: A quantidade de tempo, em milissegundos, que a API levou para ser executada.
• IP de origem: O endereço IP externo do aplicativo ou servidor que chamou a API.
• Aplicativo de origem: O aplicativo de origem para a chamada de API, presente apenas quando a chamada de API está sendo transmitida em um cabeçalho de solicitação. Passe o mouse sobre a coluna Aplicativo de origem para visualizar o conteúdo do campo.

Cada página exibe 20 logs. Você pode visualizar todos os logs dentro do filtro e critérios de pesquisa usando os botões Próximo e Anterior.

Visualizando Detalhes do Registro¶

Para visualizar detalhes de log adicionais ou logs de depurar (se ativado), clique em expandir ícone em uma entrada de log:

Um log de API típico conterá estes detalhes:

• Nome de domínio da região Harmony, caminho do serviço e URL base (consulte URL do serviço da API)
• Tempo de processamento de chamada de API
• Informações do perfil de segurança, como tipo de autorização e credenciais usadas
• Detalhes do payload, incluindo o comprimento do payload e o tamanho da resposta
• Informações de erro (se aplicável)
• Logs de depuração (se ativado)
• Logs detalhados (se habilitado)