Página de logs da API no Jitterbit API Manager

Introdução

A página Logs da API no API Manager exibe uma tabela de todos os logs de processamento da API e logs de depuração (se o registro de depuração estiver habilitado). Logs são gerados para APIs personalizadas, OData e proxy quando são chamadas através do gateway de API em nuvem ou de um gateway de API privado. Quando uma API aciona uma operação do Studio, os logs da operação resultante também aparecem na página Logs da API, além da visualização de logs de operação do Studio e da página Runtime do Console de Gerenciamento.

Chamadas de API geram quatro tipos de logs:

• Logs da API: O API Manager gera automaticamente logs da API na página Logs da API para cada chamada de API do API Manager. Os logs da API contêm informações sobre a chamada da API, incluindo o timestamp da solicitação da API, o código de status HTTP, o ID da solicitação, o método da solicitação, a URI da solicitação, o tempo de resposta, o IP de origem da aplicação que faz a chamada, a aplicação de origem e quaisquer mensagens de log.

• Logs de depuração da API: Informações detalhadas de rastreamento mostrando cada etapa do processamento da solicitação através da URL de serviço de uma API do API Manager. O registro de depuração da API não está habilitado por padrão e deve ser ativado em uma API do API Manager individual. Para habilitar o registro de depuração, veja a aba Configurações na configuração da API personalizada, configuração da API OData ou configuração da API proxy.

• Logs detalhados da API: Dados de carga útil de solicitação e resposta recebidos ou enviados através da URL de serviço de uma API do Gerenciador de API. O registro detalhado da API não está habilitado por padrão e deve ser ativado em uma API do Gerenciador de API individual. Para habilitar o registro detalhado, veja a aba Configurações em configuração de API personalizada, configuração de API OData ou configuração de API proxy.

• Logs de operação do agente privado: Informações sobre chamadas de API registradas no arquivo jitterbit.log do agente privado localizado no diretório log. Esses logs contêm o início de uma chamada de API e o tempo decorrido. Os logs de operação do agente privado são configurados no arquivo de configuração do agente privado.

Para adicionar informações de log adicionais para APIs OData, incluindo dados SQL enviados ao banco de dados, edite o arquivo de configuração do agente privado e defina DebugJDML como true.

Acesse a página de Logs da API

Para acessar a página Logs da API, use o menu do portal Harmony para selecionar Gerenciador de API > Logs da API.

Controles de Logs da API

A página Logs da API possui controles para filtrar os dados exibidos na tabela de logs, definir o intervalo de tempo e gerenciar o layout da tabela.

Você pode ajustar os dados exibidos usando os controles de consulta salvos, a barra de pesquisa, o menu de intervalo de tempo e os ícones da barra de ferramentas.

Consultas

A barra de pesquisa permite filtrar as entradas de log pelos critérios listados abaixo. Insira um ou mais termos de pesquisa na barra de pesquisa para filtrar a tabela de entradas de log.

Os termos de busca utilizam um dos dois operadores:

• =: Retorna entradas de log onde o campo corresponde ao valor.
• !=: Retorna entradas de log onde o campo não corresponde ao valor.

Padrões curinga são suportados com ambos os operadores:

• value%: Corresponde a entradas onde o campo começa com o valor.
• %value%: Corresponde a entradas onde o campo contém o valor.
• %value: Corresponde a entradas onde o campo termina com o valor.

Estes são os critérios de busca suportados:

Combine queries

As consultas podem conter uma combinação de critérios. Os critérios de busca combinados devem ser separados por um ponto e vírgula (;) entre cada critério. Os operadores = e != podem ser usados juntos na mesma busca. Estes são exemplos de buscas 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%;

sourceapp!=Mozilla%;message=%REJECT%;
sourceapp!=%Chrome%;responsetime<=2;
message!=%Access Denied%;requesturi=%contacts%;
sourceip!=70.5%;sourceapp=%Chrome%;

Saved queries

As consultas podem ser salvas e reutilizadas, podendo ser editadas ou excluídas:

• Salvar uma consulta: Clique em Salvar consulta. Um formulário de consulta é aberto:

  • Nome: Insira um nome para a consulta salva.
  • Consulta: Os termos de busca atuais são preenchidos automaticamente. Edite ou adicione termos de consulta usando a mesma sintaxe da barra de busca. Clique no campo para mostrar uma lista de termos de busca disponíveis ou digite um termo seguido de um ponto e vírgula.

  Clique em Salvar para salvar a consulta.

• Usar uma consulta salva: Clique em Consultas salvas para abrir a lista de consultas salvas, em seguida, clique em uma consulta para aplicá-la. Os termos de busca são aplicados à barra de busca e os resultados são atualizados automaticamente.

  Nota

  Os valores do intervalo de datas de uma consulta salva são aplicados ao seletor de período de tempo, não à barra de busca.

• Editar uma consulta salva: Clique em Consultas salvas, em seguida, clique no ícone Editar da consulta que você deseja editar. Atualize o nome ou os termos da consulta e clique em Salvar.

• Excluir uma consulta salva: Clique em Consultas salvas, em seguida, clique no ícone Excluir da consulta que você deseja excluir. Confirme a exclusão quando solicitado.

Time period selector

O seletor de período de tempo exibe o intervalo de tempo atualmente selecionado (por exemplo, Últimas 24 horas) e permite ajustar o intervalo de tempo dos dados do log da API:

Clique no seletor de período de tempo para abrir um diálogo com duas abas: Relativo e Absoluto.

Aba Relativa

A aba Relativa fornece intervalos de tempo predefinidos e um seletor de período de tempo relativo personalizado:

Selecione um dos intervalos de tempo predefinidos:

• Últimas 24 horas: Exibe os dados de log da API das últimas 24 horas.

• Últimas 48 horas: Exibe os dados de log da API das últimas 48 horas.

• Últimas 72 horas: Exibe os dados de log da API das últimas 72 horas.

Para criar um período de tempo relativo personalizado, use os controles na parte inferior do diálogo:

• Campo numérico: Insira o número de unidades de tempo (por exemplo, 1, 7, 30).

• Dropdown de unidade: Selecione a unidade de tempo entre Minutos, Horas, Dias, Semanas ou Meses.

• Cancelar: Feche o diálogo sem aplicar alterações.

• Aplicar: Aplique o intervalo de tempo selecionado e feche o diálogo.

Aba Absoluta

A aba Absoluta permite selecionar um intervalo específico de data e hora dentro dos últimos 30 dias:

O intervalo de datas selecionado é exibido na parte superior do diálogo no formato MM/DD/YYYY, HH:mm am/pm - MM/DD/YYYY, HH:mm am/pm.

Configure o intervalo de data e hora usando os seguintes controles:

• Campo de hora de início: Exibe a hora de início do intervalo. Clique para limpar ou clique para ajustar a hora.

• Campo de hora de término: Exibe a hora de término do intervalo. Clique para limpar ou clique para ajustar a hora.

• Seletor de calendário: Use o calendário para selecionar as datas de início e término. Navegue entre os meses usando as setas esquerda e direita.

• Cancelar: Feche o diálogo sem aplicar alterações.

• Aplicar: Aplique o intervalo de data e hora selecionado e feche o diálogo.

Controles adicionais

Controles adicionais aparecem no lado direito da barra de ferramentas:

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

  Nota

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

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

• Filtrar colunas: Clique para alterar a visibilidade e a ordem das colunas. O painel lateral Colunas se abre com os seguintes controles:

  • Pesquisar: Digite parte ou o nome completo de uma coluna para reduzir a lista àquelas que correspondem ao texto.

  • Mostrar Todas: Tornar todas as colunas visíveis.

  • Mover: Arraste e solte para alterar a posição da coluna em relação às outras.

  • Visível: A coluna é exibida na tabela. Clique para ocultá-la.

  • Oculta: A coluna não é exibida na tabela. Clique para mostrá-la.

  • Salvar: Salvar quaisquer alterações nas colunas.

  • Cancelar: Fechar o editor de colunas sem salvar alterações.

Configurações da página

O canto superior direito da página contém o botão de alternância Visualização da árvore de execução e o ícone Configurações:

• Visualização da árvore de execução: Alternar para controlar como os resultados da pesquisa exibem a hierarquia pai-filho das entradas do log. Quando ativado, os resultados da pesquisa incluem toda a cadeia de execução para cada entrada correspondente: se a correspondência for uma entrada de log de API, todas as suas entradas de operação filhas são mostradas; se a correspondência for uma entrada de operação, sua entrada de log de API pai e quaisquer operações irmãs ou filhas também são mostradas. Quando desativado, apenas as entradas que correspondem diretamente aos critérios de pesquisa são mostradas, sem pais ou filhos.

• Configurações: Clique para abrir o painel Configurações. Selecione um intervalo de atualização automática, um dos seguintes: Nunca (o padrão), 1 minuto, 5 minutos, 15 minutos ou 30 minutos, e clique em Salvar.

Tabela de entradas de log

Cada linha na tabela Logs da API exibe dados de registro para uma chamada de API ou uma operação acionada por essa chamada.

As seguintes colunas estão disponíveis:

Passe o mouse sobre uma entrada de log para revelar as ações disponíveis. As ações diferem de acordo com o tipo de log:

Para entradas de log de API Personalizada, API Proxy e API OData:

• Visualizar: Abra os detalhes do log da API.
• Abrir API: Abra a API no Gerenciador de API.

Para entradas de log de Operação:

• Visualizar: Abra os detalhes do log da API.
• Cancelar operação: Habilitado para operações que estão em status Enviado, Recebido, Pendente ou Em Execução. Cancelar operação envia uma solicitação ao agente para parar a operação. Uma vez clicado, o status Cancelamento Solicitado é exibido ao lado do status da operação em tempo real.
• Ir para operação: Abra o projeto no Studio e selecione a operação. Esta ação está disponível apenas para operações do Studio, não para operações do Design Studio.

Quando há mais de 100 entradas de log, elas são divididas em páginas de 100 cada. Use os botões de navegação Página Anterior e Próxima Página na parte inferior da tabela para navegar entre as páginas.

Detalhes do log da API

Para visualizar detalhes adicionais ou logs de depuração (se habilitados) para uma entrada de log, clique na entrada na tabela. Um painel se abre na parte inferior da página com as seguintes abas, dependendo do tipo de log:

• Entradas de log de API Personalizada, API Proxy e API OData: Mensagens e Registro de Depuração.
• Entradas de log de Operação: Mensagens, Logs de Atividade e Registro de Depuração.

O painel é intitulado Mensagens e Logs e exibe o nome, status, hora de início, hora de término e duração da entrada de log selecionada.

Aba Mensagens

O conteúdo da aba Mensagens difere dependendo do tipo de log da entrada selecionada.

Entradas de log da API

Quando uma entrada de log de API Personalizada, API Proxy ou API OData é selecionada, a aba Mensagens exibe detalhes sobre a chamada da API nas seguintes seções colapsáveis: informações da API, informações da chamada, log da chamada e Payload da API (quando habilitado).

Informações da API

A seção informações da API exibe os seguintes detalhes:

• API: O nome da API que acionou a operação. Clique para abrir a configuração da API em uma nova aba no Gerenciador de API.

• Versão: O número da versão da API.

• Tipo de API: O tipo da API, um dos seguintes:

  • CUSTOM_API: Uma API personalizada criada no Gerenciador de API.
  • ODATA: Uma API OData criada no Gerenciador de API.

• Método de Solicitação: O método HTTP usado para a chamada da API. Os valores possíveis incluem GET, POST, PUT, DELETE, PATCH e MERGE.

• ID da solicitação da API: Um identificador único para a solicitação da API. Você pode usar esse ID para correlacionar logs entre diferentes sistemas e para buscar solicitações específicas. Clique para copiar o valor.

• IP de origem: O endereço IP da aplicação cliente ou servidor que fez a solicitação da API.

• Gateway da API: O gateway da API que processou a solicitação. Este campo mostra o nome de domínio do gateway de API em nuvem ou do gateway de API privado que lidou com a chamada da API.

• URL do serviço da API: A URL completa para chamar a API, incluindo a URL base, raiz do serviço, versão e quaisquer parâmetros de caminho. Esta é a URL do serviço da API completa conforme consumida pelo cliente.

• Aplicativo de Origem: O aplicativo ou navegador que fez a solicitação da API.

Informações da Chamada

A seção Informações da Chamada exibe os cabeçalhos de solicitação HTTP enviados com a chamada da API sob o rótulo Cabeçalhos da Solicitação. Cada cabeçalho é exibido como um par chave-valor, como accept, accept_encoding, content_length, fulluri, host, user_agent e cabeçalhos de encaminhamento.

Registro de Chamadas

A seção Registro de Chamadas exibe mensagens de log em nível de sistema geradas durante o processamento da solicitação da API. Clique para copiar o log para sua área de transferência.

Payload da API

A seção Payload da API exibe os dados de payload de solicitação e resposta para a chamada da API. Esta seção é visível quando uma ou ambas das seguintes opções estão habilitadas na aba Configurações da API: Habilitar modo de depuração até ou Mostrar Payloads de Solicitação e Resposta nos Logs.

A seção é dividida em dois painéis:

• Corpo da Solicitação: O payload enviado com a solicitação da API.

• Corpo da Resposta: O payload retornado pela API. Se o payload da resposta exceder o limite de exibição, ele é mostrado com o rótulo (Truncado).

Cada painel fornece os seguintes controles:

• Pesquisar: Pesquisar o payload por uma string específica.

• Copiar: Copiar o payload para sua área de transferência.

• Baixar: Baixar o payload como um arquivo.

Entradas do Registro de Operação

Quando uma entrada de log de Operação é selecionada, a aba Mensagens exibe o seguinte:

• Registros de Origem: Ao usar uma atividade de FTP ou Banco de Dados como origem, a contagem de registros que foram lidos do sistema de origem é exibida. Para outros conectores, a contagem é 0, independentemente do número de registros de origem.

• Registros de Destino: Ao usar uma atividade de FTP ou Banco de Dados como destino, a contagem de registros que foram postados no sistema de destino é exibida. Para outros conectores, a contagem é 0, independentemente do número de registros de destino.

• Mensagem: Detalhes do log para a operação, incluindo qualquer um dos seguintes:

  • Mensagens geradas pelo sistema indicando que a operação foi concluída sem erro.
  • Mensagens de informação e aviso retornadas pelos sistemas de origem ou destino.
  • Avisos de validação retornados pelos serviços de transformação, validação e script do Jitterbit.
  • Mensagens definidas pelo usuário geradas pela ferramenta Invoke Operation (quando Levantar erro se a operação falhar está habilitado) ou pela função WriteToOperationLog().

  Nota

  • Datas e horas nas mensagens de log aparecem em seu formato original da fonte e não são convertidas para o horário local do navegador.
  • Mensagens de log que excedem ~100 KB de tamanho (~99.000 caracteres) são truncadas, com mensagem truncada aparecendo no final do log.

  Clique para copiar ou para baixar as mensagens de log.

• Mensagens registradas em scripts de pré-transformação: Mensagens geradas durante a execução de scripts de pré-transformação. Clique para copiar ou para baixar.

Aba de Logs de Atividade

A aba Logs de Atividade contém links para arquivos de sucesso ou falha criados por atividades do Salesforce, Salesforce Service Cloud ou ServiceMax executadas em um agente privado. Os arquivos estão no formato CSV. Clique em um link para baixar.

Os arquivos de log de atividade são automaticamente excluídos após 14 dias pelo serviço de limpeza de arquivos do agente privado. Você pode alterar esse comportamento na seção [ResultFiles] do arquivo de configuração do agente privado jitterbit.conf, ou alterando as regras do serviço de limpeza de arquivos.

Os downloads do registro de atividades estão desativados para agentes em nuvem. Você pode ver links de download, mas tentar baixar gera uma mensagem de erro.

Aba de Registro de Depuração

Quando o registro de depuração está habilitado no nível da operação (para agentes em nuvem ou para agentes privados) e a operação foi executada em um agente 10.48 ou posterior, esta aba mostra os detalhes da hierarquia completa de execução de uma operação do Studio. A visualização do log da operação exibe uma visão dividida com logs de operação no painel esquerdo e informações detalhadas do log para a operação selecionada no painel direito. A visualização utiliza os controles de tabela selecionados para filtrar os resultados. Se as operações estiverem encadeadas com ações de operação ou a função RunOperation, essas operações são listadas sob a operação pai.

Quando o registro de depuração da operação está habilitado, esta aba também pode exibir dados de entrada e saída de componentes e dados de solicitação e resposta da API (quando a operação é acionada por uma API do API Manager). O payload de solicitação e resposta é incluído apenas quando Mostrar Payloads de Solicitação e Resposta nos Logs também está habilitado na Aba de Configurações da API.

As operações pai (e quaisquer operações filhas abaixo delas) são classificadas em ordem crescente por Iniciado. A tabela pode ser classificada (apenas para operações de nível superior) por Nome, Iniciado, Finalizado, Duração ou Status clicando na respectiva linha do cabeçalho.

Quando você abre a visualização do log da operação, o primeiro log de operação na lista é selecionado por padrão. As informações detalhadas do log para esta operação aparecem no painel direito.

• Nome: O nome da operação ou etapa da operação. Os caret, que podem ser usados para expandir ou colapsar linhas adicionais, são mostrados nas operações pai e nas operações para as quais dados de entrada e saída de componentes estão disponíveis:

• Operações pai: Quando uma operação pai é expandida, linhas adicionais para suas operações filhas aparecem na ordem em que foram executadas. Por padrão, todas as operações pai estão expandidas. Use os ícones colapsar lista ou expandir lista para colapsar ou expandir todas as operações pai.

• Iniciado: A data e hora em que a operação ou etapa da operação começou a ser executada, exibida como o horário local do navegador.

• Finalizado: A data e hora em que a operação ou etapa da operação parou de ser executada, exibida como o horário local do navegador.

• Duração: O tempo decorrido entre Iniciado e Finalizado, reportado em segundos para operações e em milissegundos para etapas de operação.

• Status: O status da operação ou etapa da operação. Para uma lista completa de possíveis status, veja a tabela de detalhes da operação.

• Ações: Essas ações estão disponíveis para operações (não para etapas de operação):

  • Cancelar operação: Habilitado para operações que estão com status Enviado, Recebido, Pendente ou Executando. Cancelar operação envia uma solicitação ao agente para parar a operação. Uma vez clicado, o status Cancelamento Solicitado é exibido ao lado do status da operação em tempo real.

    Nota

    Operações que têm o status Cancelamento Solicitado ainda podem ser executadas.

  • Ir para operação: Abra o projeto no Studio e selecione a operação.

• Atualizar: Clique para atualizar a lista de logs de operação.

• Filtrar Colunas: Clique para abrir uma gaveta que permite reorganizar as colunas ou ajustar sua visibilidade no painel da lista de operações:

  

  • Mostrar Tudo: Tornar todas as colunas visíveis.

  • Mover: Arraste e solte para mudar a posição da coluna em relação às outras.

  • Ocultar: A coluna está visível. Clique para ocultá-la.

• Mostrar: A coluna está oculta. Clique para mostrá-la.

• Redimensionar colunas: Arraste a barra de Redimensionar de uma coluna para redimensioná-la.

• Registro de operações: Para mostrar ou ocultar um registro de uma operação individual, clique em uma operação da lista.

  • Mensagens de registro: As mensagens de registro incluem os detalhes do log para a operação selecionada. A exibição das mensagens de registro depende das permissões e níveis de acesso do usuário atual e se o registro em nuvem está habilitado. Para mais informações, veja a aba Mensagens mais acima nesta página.

    Nota

    As datas e horas exibidas nas mensagens de registro não são convertidas para o horário local do navegador, mas são reportadas em seu formato original da fonte da mensagem de registro.

  • Copiar: Copia os dados do log para sua área de transferência.

  • Baixar: Baixa as mensagens de registro como um arquivo de texto.
  • Mostrar / ocultar: Mostra ou oculta as mensagens de registro.

Dados de entrada e saída do componente

Os dados de entrada e saída do componente são gerados quando uma operação tem o registro de depuração de operação habilitado no nível da operação (para agentes em nuvem ou para agentes privados) e a operação foi executada em um agente 10.48 ou posterior.

Quando os dados de entrada e saída do componente estão presentes, uma representação gráfica da operação ou etapa da operação é exibida no painel da lista de operações.

Ícones para atividades e transformações usadas como etapas da operação são exibidos. Você pode clicar em uma etapa da operação para mostrar ou ocultar os dados de entrada e saída do componente para essa etapa específica. Cada entrada de log de entrada e saída é limitada a 100 MB. Se os dados de uma entrada de log de entrada ou saída individual excederem 100 MB, nenhum dado será exibido.

• Pesquisar: Pesquise os dados para o texto inserido.
• Copiar: Copia os dados do log para sua área de transferência.
• Baixar: Baixa os dados de entrada ou saída como um arquivo no formato de dados apropriado. O arquivo é nomeado com o nome da etapa da operação seguido de _input ou _output, conforme apropriado.

Dados de solicitação e resposta da API

Quando uma operação é acionada por um API personalizada do Gerenciador de API ou API OData, a quantidade de informações exibidas nos detalhes da entrada de log depende das configurações que estão habilitadas:

Para habilitar o registro de depuração da operação, consulte registro de depuração da operação para agentes em nuvem ou registro de depuração da operação para agentes privados. Para exibir payloads de solicitação e resposta, habilite Mostrar Payloads de Solicitação e Resposta nos Logs na aba Configurações da API.

API Manager Log Service API (Beta)

Como alternativa para baixar um arquivo de log da API clicando em Baixar como CSV, é possível recuperar logs da API programaticamente usando a API Manager Log Service API (Beta).