Ir para o conteúdo

Página de logs de API no Jitterbit API Manager

Introdução

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

Página API Logs

Importante

O Harmony retém dados de log para logs de API, logs de depuração de API e logs detalhados de API por 30 dias a partir da data em que a API é consumida.

Nota

Para detalhes sobre quais informações são registradas quando uma API dispara uma operação, consulte Dados de requisição e resposta de API.

Chamadas de API geram quatro tipos de logs:

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

  • Logs de depuração de API: Informações de rastreamento detalhadas mostrando cada etapa do processamento de requisição através da URL do serviço de uma API do API Manager. O log de depuração de API não está ativado por padrão e deve ser ativado em cada API do API Manager individualmente. Para ativar o log de depuração, consulte a aba Settings em configuração de API personalizada, configuração de API OData ou configuração de API proxy.

  • Logs detalhados de API: Dados brutos de requisição e resposta adicionados ao log de chamada quando uma requisição de API é feita, incluindo headers, parâmetros e bodies de requisição e resposta. O log detalhado de API não está ativado por padrão e deve ser ativado em cada API do API Manager individualmente. Para ativar o log detalhado, consulte a aba Settings 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 gravadas 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 para o banco de dados, edite o arquivo de configuração do agente privado e defina DebugJDML como true.

Acessar a página de API Logs

Para acessar a página API Logs, use o menu Harmony portal para selecionar API Manager > API Logs.

Barra de ferramentas

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

Barra de ferramentas API Logs

É possível ajustar os dados exibidos usando os controles de consulta salva, barra de pesquisa, menu de intervalo de tempo e ícones da barra de ferramentas.

Consultas

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

Para criar uma consulta sem digitar a sintaxe de busca diretamente, clique no ícone à direita da barra de pesquisa. Um painel de busca abre com campos agrupados nas seções Comum, API e Operação. Para cada campo, clique no controle de operador = para escolher Igual a ou Não igual a na lista suspensa que abre e, em seguida, digite ou selecione um valor para corresponder. Alguns campos têm o controle de operador desativado e usam apenas Igual a. Clique em Buscar para executar a consulta ou em Limpar para apagar todos os campos. O painel constrói a mesma sintaxe de consulta descrita nesta seção, e a consulta resultante aparece na barra de pesquisa. A seção API inclui um campo Perfil de segurança para filtrar entradas de log por perfil de segurança.

Cada campo aplicado no painel também aparece como uma etiqueta ao lado do seletor de período de tempo, identificada com o nome do campo (por exemplo, Ambiente ou Perfil de segurança). O número na etiqueta mostra quantos valores estão aplicados a esse campo. Por exemplo, uma etiqueta com 2 significa que dois ambientes estão selecionados. Clique em em uma etiqueta para limpar todos os valores desse campo ou clique em Limpar filtros para apagar todos os filtros aplicados.

Nota

A página de Logs de API lembra suas seleções de filtro usadas por último. Se você não está vendo os resultados esperados, confirme se os filtros aplicados anteriormente foram removidos.

Os termos de busca usam um dos dois operadores:

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

Padrões com caracteres curinga são compatíveis com ambos os operadores. Use % ou * como o caractere curinga:

  • value% ou value*: Corresponde a entradas em que o campo começa com o valor.
  • abc%d ou abc*d: Corresponde a entradas em que o campo começa com abc, termina com d e tem qualquer caractere no meio.

A correspondência com curinga está ancorada ao início do valor do campo, portanto apenas buscas por início (prefixo) retornam resultados. Um curinga no início não amplia a correspondência: %value% e *value* são tratados como value% (começa com). Pesquisar por texto que aparece apenas no meio ou no final de um campo não retorna mais resultados.

Estes são os critérios de busca compatíveis:

Critério Busca Válida Busca Inválida
ID da Requisição apiRequestId=123%;
apiRequestId=fI9KRyjM%;
apiRequestId!=123%;
apiRequestId!=fI9KRyjM%;
URI da Requisição requesturi=https://acme2.jitterbit.net%;
requesturi=https://acme2.jitterbit.net/defaultUrlPrefix%;
requesturi!=https://acme2.jitterbit.net%;
URL do Serviço de API apiServiceUrl=https://acme2.jitterbit.net/defaultUrlPrefix%;
apiServiceUrl=https://acme2.jitterbit.net/defaultUrlPrefix/v1/customers;
apiServiceUrl!=https://acme2.jitterbit.net/defaultUrlPrefix%;
IP de Origem sourceip=14.141%;
sourceip!=14.141%;
Aplicação de Origem sourceApplication=Mozilla%;
sourceApplication!=Mozilla%;
Mensagem message=REJECT;
message=Access Denied;
message!=REJECT;
message!=Access Denied;
Status apiStatus=200;
apiStatus!=200;
apiStatus=abc;
Nome da API api=Get Customer%;
api!=Get Customer%;
Nome da Operação operation=New Delete;
operation!=New Delete;
Tipo de Log logType=Custom API;
logType=Proxy API;
logType=OData Service;
ID id=fI9KRyjM;
id!=fI9KRyjM;
Ambiente environment=Sandbox;
environment!=Sandbox;
Método de Requisição apiRequestMethod=GET;
apiRequestMethod!=GET;
Gateway de API apiGateway=acme2.jitterbit.net%;
apiGateway!=acme2.jitterbit.net%;
Tipo de Gateway gatewayType=Public;
gatewayType=Private;
Tipo de Autenticação authType=OAuth 2.0;
authType=Anonymous;
Perfil de Segurança securityProfile=Internal Developer Security;
securityProfile!=Internal Developer Security;
ID da Operação operationGuid=0f04b6f6-4129-45dd-8388-abd19fe6a4f7;
operationGuid!=0f04b6f6-4129-45dd-8388-abd19fe6a4f7;
Agente agent=Windows%;
agent!=Windows%;
Projeto project=SFDC-SAP;
project!=SFDC-SAP;
GUID da Instância de Operação Raiz rootOperationInstanceGuid=0f04b6f6-4129-45dd-8388-abd19fe6a4f7;

Nota

  • Digite a URL completa do serviço de API, incluindo o esquema https://, como o valor do critério apiServiceUrl.
  • O critério message não suporta caracteres curinga. Digite o texto a ser correspondido como uma frase; a busca retorna entradas cuja mensagem contém esse texto.
  • O critério apiStatus aceita apenas códigos de status HTTP numéricos. Um valor não numérico é sinalizado como inválido, indicado por um contorno vermelho ao redor do campo.
  • O critério logType aceita um dos seguintes valores: Custom API, Proxy API ou OData Service.
  • O critério gatewayType aceita um dos seguintes valores: Public ou Private.
  • O critério authType aceita um dos seguintes valores: Anonymous, Basic, OAuth 2.0 ou API key.
  • O critério securityProfile corresponde ao nome de um perfil de segurança. Use-o em vez de authType para isolar entradas de log de um perfil de segurança quando vários perfis de segurança compartilham o mesmo tipo de autenticação, como múltiplos perfis de chave de API.

As consultas podem conter uma combinação de critérios. Os critérios de busca combinados devem ser separados por 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=https://acme2.jitterbit.net%;
apiRequestId=yzaccwui%;message=REJECT;
sourceApplication=Mozilla%;message=REJECT;
sourceip=70.5%;requesturi=https://acme2.jitterbit.net%;
sourceApplication!=Mozilla%;message=REJECT;
message!=Access Denied;requesturi=https://acme2.jitterbit.net%;
sourceip!=70.5%;sourceApplication=Mozilla%;

Consultas salvas

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

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

    • Nome: Digite um nome para a consulta salva.
    • Consulta: Os termos de busca atuais são preenchidos previamente. Edite ou adicione termos de consulta usando a mesma sintaxe da barra de pesquisa. Clique no campo para exibir uma lista de termos de busca disponíveis ou digite um termo seguido por 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 e clique em uma consulta para aplicá-la. Os termos de busca são aplicados à barra de pesquisa 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 pesquisa.

  • Editar uma consulta salva: Clique em Consultas salvas e clique no ícone Editar para a consulta que deseja editar. Atualize o nome ou os termos de consulta e clique em Salvar.

  • Excluir uma consulta salva: Clique em Consultas salvas e clique no ícone Excluir para a consulta que deseja excluir. Confirme a exclusão quando solicitado.

Seletor de período de tempo

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 de log da API:

seletor de período de tempo

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

Aba Relativo

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

aba relativo

Selecione um dos intervalos de tempo predefinidos:

  • Últimas 24 horas: Exibe dados de log da API dos últimos 24 horas.

  • Últimas 48 horas: Exibe dados de log da API dos últimos 48 horas.

  • Últimas 72 horas: Exibe dados de log da API dos últimos 72 horas.

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

  • Campo de número: Digite o número de unidades de tempo (por exemplo, 1, 7, 30).

  • Menu suspenso de unidade: Selecione a unidade de tempo entre Minutes, Hours, Days, Weeks ou Months.

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

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

Absolute tab

A aba Absolute permite selecionar um intervalo de data e hora específico nos últimos 30 dias. Datas fora deste intervalo não podem ser selecionadas:

absolute tab

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:

  • Start time field: Exibe a hora de início do intervalo. Clique em para limpar ou clique em para ajustar a hora.

  • End time field: Exibe a hora de término do intervalo. Clique em para limpar ou clique em para ajustar a hora.

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

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

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

Additional controls

Controles adicionais aparecem no lado direito da barra de ferramentas:

  • Download as CSV: Clique para abrir o diálogo Download logs. A exportação tem as seguintes características:

    • Scope: A exportação usa os filtros e critérios de pesquisa aplicados, refletindo todas as entradas de log correspondentes. Isto é equivalente ao conjunto de resultados completo exibido em todas as páginas da tabela.
    • Hierarchy: A exportação preserva a hierarquia pai-filho das entradas de log de API e operação, mantendo cadeias relacionadas contíguas.
    • Order: Os registros são ordenados pela hora de Started do pai (descendente), com registros de operação filho ordenados pela sequência de execução (ascendente).
    • Time zone: Os timestamps de Started e Finished usam o fuso horário local do seu navegador.
    • Packaging: Quando a exportação abrange vários arquivos, todos os arquivos são empacotados em um único arquivo ZIP para download.

    O diálogo contém a seguinte opção:

    • Include messages: Selecione para incluir mensagens de log completas na exportação. Esta opção não é selecionada por padrão. Incluir mensagens pode aumentar significativamente o tamanho do arquivo e o tempo de geração.

    Clique em Download para iniciar a exportação ou Cancel para descartar.

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

  • Filter columns: Clique para alterar a visibilidade e a ordem das colunas. O painel lateral Columns abre com os seguintes controles:

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

    • Show All: Torne todas as colunas visíveis.

    • Move: Arraste e solte para alterar a posição da coluna em relação aos outros.

    • Visible: A coluna é exibida na tabela. Clique para ocultá-la.

    • Hidden: A coluna não é exibida na tabela. Clique para exibi-la.

    • Save: Salve as alterações feitas nas colunas.

    • Cancel: Feche o editor de colunas sem salvar as alterações.

Page settings

O canto superior direito da página contém o botão Execution tree view e o ícone Settings:

page settings

  • Execution tree view: Alterne para controlar como os resultados da pesquisa exibem a hierarquia pai-filho das entradas de log. Quando ativado, os resultados da pesquisa incluem a cadeia de execução completa para cada entrada correspondente: se a correspondência for uma entrada de log de API, todas as suas entradas de operação filho serão exibidas; se a correspondência for uma entrada de operação, sua entrada de log de API pai e qualquer operação irmã ou filha também serão exibidas. Quando desativado, apenas as entradas que correspondem diretamente aos critérios de pesquisa são exibidas, sem pais ou filhos.

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

Tabela de entradas de log

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

Dica

Para alterar a visibilidade e a ordem das colunas, use Filtrar colunas, descrito em controles adicionais.

tabela de entradas de log

As seguintes colunas estão disponíveis:

Coluna Descrição Aplica-se a
Nome O nome da API ou operação associada à entrada de log. Todas
Tipo de Log O tipo de entrada de log: API Personalizada, API Proxy ou API OData para entradas de log de API, ou Operação para entradas de log de operação. Entradas de log de operação aparecem automaticamente quando uma chamada de API aciona uma operação do Studio. Nenhuma configuração adicional é necessária. Todas
Ambiente O nome do ambiente onde a API é implantada. Todas
Status O status da entrada de log. Para entradas de log de API, este é o código de status HTTP (consulte definições de código de status w3.org). Para entradas de log de Operação, este é o status da operação. Todas
Iniciado O timestamp quando a solicitação de API foi recebida ou a operação começou a ser executada. Os horários são exibidos no fuso horário do seu navegador. Todas
Concluído O timestamp quando a chamada de API ou operação foi concluída. Os horários são exibidos no fuso horário do seu navegador. Este campo fica em branco enquanto a chamada de API ou operação ainda está em execução. Todas
Duração O tempo decorrido entre Iniciado e Concluído. Este campo fica em branco enquanto a chamada de API ou operação ainda está em execução. Todas
ID O identificador único para a entrada de log. Todas
URL do Serviço de API A URL completa para chamar a API, incluindo a URL base, raiz de serviço, versão e quaisquer parâmetros de caminho. Apenas API
Versão da API O número da versão da API. Apenas API
Método de Solicitação O método HTTP usado para a chamada de API. Os valores possíveis incluem GET, POST, PUT, DELETE, PATCH e MERGE. Apenas API
IP de Origem O endereço IP do aplicativo cliente ou servidor que fez a solicitação de API. Apenas API
Aplicação de Origem O aplicativo ou navegador que fez a solicitação de API. Apenas API
Gateway de API O nome de domínio do gateway de API em nuvem ou gateway de API privado que processou a solicitação. Apenas API
Tipo de Gateway O tipo de gateway de API que processou a solicitação, Público (gateway de API em nuvem) ou Privado (gateway de API privado). Apenas API
Tipo de Autenticação O tipo de autenticação usado pelo perfil de segurança atribuído à API. Apenas API
Agente O nome do agente que processou a operação. Apenas Operação
Projeto O nome do projeto associado à entrada de log. Apenas Operação
GUID da Instância da Operação Raiz O identificador globalmente único (GUID) da instância da operação raiz. Apenas Operação
ID da Operação O identificador único da operação acionada pela chamada de API. Apenas Operação

Nota

Tipo de Log nesta tabela refere-se à categoria da entrada de log, não aos tipos de log de API (logs de API, logs de depuração, logs detalhados, logs de operação do agente privado) descritos na Introdução.

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

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

Para entradas de log de Operação:

  • Visualizar: Abre os detalhes do log da API.
  • Cancelar operação: Disponível para operações com status Enviada, Recebida, Pendente ou Em execução. Cancelar operação envia uma solicitação ao agente para interromper a operação. Após clicar, o status Cancelamento solicitado é exibido ao lado do status da operação em tempo real.

    Nota

    Enviar uma solicitação de cancelamento não garante que a operação será cancelada. Operações com status Cancelamento solicitado ainda podem ser executadas, dependendo do estado de execução atual do agente.

  • Ir para operação: Abre o projeto no Studio e seleciona 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 ativados) de 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:

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 varia dependendo do tipo de log da entrada selecionada.

Entradas de log da API

Quando uma entrada de log Custom API, Proxy API ou OData API é selecionada, a aba Mensagens exibe detalhes sobre a chamada da API nas seguintes seções expansíveis: Informações da API, Informações da chamada, Log de chamada e Carga da API (quando ativado).

Aba Mensagens

Informações da API

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

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

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

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

  • 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 de API: Um identificador exclusivo para a solicitação de API. Você pode usar este ID para correlacionar logs em diferentes sistemas e pesquisar solicitações específicas. Clique em para copiar o valor.

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

  • Gateway de API: O gateway de API que processou a solicitação. Este campo mostra o nome de domínio do gateway de API na nuvem ou gateway de API privado que tratou 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 completa do serviço da API conforme consumida pelo cliente.

  • Aplicação de origem: A aplicação ou navegador que fez a solicitação de 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 em um rótulo Cabeçalhos de 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. Os cabeçalhos que transportam credenciais ou dados de sessão são mascarados, conforme descrito em Cabeçalhos mascarados.

Registro de chamadas

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

Carga útil de API

A seção Carga útil de API exibe os dados de carga útil de solicitação e resposta para a chamada de API. Esta seção fica visível quando uma ou ambas as opções a seguir são habilitadas na guia Configurações da API: Ativar modo de depuração até ou Mostrar Cargas Úteis de Solicitação e Resposta em Logs.

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

  • Corpo da solicitação: A carga útil enviada com a solicitação de API.

  • Corpo da resposta: A carga útil retornada pela API. Se a carga útil de resposta exceder o limite de exibição, ela é mostrada com um rótulo (Truncated).

Cada painel fornece os seguintes controles:

  • Pesquisar: Pesquise a carga útil por uma string específica.

  • Copiar: Copie a carga útil para a área de transferência.

  • Baixar: Baixe a carga útil como um arquivo.

Entradas de registro de operação

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

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

  • Registros de destino: Ao usar uma atividade FTP ou Banco de dados como destino, a contagem de registros que foram postados no sistema de destino é exibida. Para outros conectores, a contagem mostra 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 scripts do Jitterbit.
    • Mensagens definidas pelo usuário geradas pela ferramenta Invocar Operação (quando Gerar erro se a operação falhar está habilitado) ou pela função WriteToOperationLog().

    As mensagens de log são exibidas como blocos individuais identificados pelo tipo de mensagem (por exemplo, Mensagem, Erro ou Erro Fatal ao processar operação). Cada bloco fornece para copiar ou para baixar seu conteúdo.

    Nota

    • Datas e horas em mensagens de log aparecem em seu formato original da origem e não são convertidas para a hora local do navegador.
    • Mensagens de log que excedem ~100 KB de tamanho (~99.000 caracteres) são truncadas, indicado com message truncated aparecendo no final do log.
  • Mensagens registradas em scripts de pré-transformação: Mensagens geradas durante a execução do script de pré-transformação. Clique em para copiar ou para baixar.

Guia Logs de atividade

Guia Logs de atividade

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

Os arquivos de log de atividade são excluídos automaticamente 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 jitterbit.conf do agente privado, ou alterando as regras do serviço de limpeza de arquivos.

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

Aba Debug Logging

Quando o debug logging está ativado no nível da operação (para agentes de nuvem ou para agentes privados) e a operação foi executada em um agente versão 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 de operação exibe uma divisão com os logs de operação no painel esquerdo e informações detalhadas de log para a operação selecionada no painel direito. A visualização usa os controles de tabela selecionados para filtrar resultados. Se as operações forem encadeadas com operation actions ou a função RunOperation, essas operações serão listadas sob a operação pai.

Quando o debug logging de operação está ativado, esta aba também pode exibir dados de entrada e saída de componentes e dados de solicitação e resposta de API (quando a operação é acionada por uma API do API Manager). O payload de solicitação e resposta é incluído apenas quando Show Request & Response Payloads in Logs também está ativado na aba Settings da API.

As operações pai (e qualquer operação filha abaixo delas) são classificadas em ordem crescente por Started. A tabela pode ser classificada (apenas para operações de nível superior) por Name, Started, Finished, Duration ou Status clicando na respectiva linha de cabeçalho.

Debug Logging tab

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

  • Name: O nome da operação ou etapa de operação. Os símbolos , que podem ser usados para expandir ou recolher linhas adicionais, são mostrados em operações pai e em 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 recolher lista ou expandir lista para recolher ou expandir todas as operações pai.
  • Started: A data e hora em que a operação ou etapa de operação começou a ser executada, exibida como a hora local do navegador.

  • Finished: A data e hora em que a operação ou etapa de operação parou de ser executada, exibida como a hora local do navegador. Este campo fica em branco enquanto a operação ou etapa de operação ainda está em execução.

  • Duration: O tempo decorrido entre Started e Finished, reportado em segundos para operações e em milissegundos para etapas de operação. Este campo fica em branco enquanto a operação ou etapa de operação ainda está em execução.

  • Status: O status da operação ou etapa de operação. Para uma lista completa de possíveis status, consulte Operation details table.

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

    • Linhas de entrada do log de API: Esta ação está disponível em linhas para a entrada do log de API que acionou a operação.

      • Go to API: Abre a página de detalhes da API correspondente no API Manager, com seu painel aberto automaticamente.
    • Linhas de operação: Essas ações estão disponíveis em linhas para a operação em si, incluindo qualquer operação filha encadeada.

      • Cancel operation: Ativada para operações que estão com status Submitted, Received, Pending ou Running. Cancel operation envia uma solicitação ao agente para interromper a operação. Uma vez clicado, o status Cancel Requested é exibido ao lado do status de operação em tempo real.

        Nota

        Enviar uma solicitação de cancelamento não garante que a operação será cancelada. Operações que têm o status Cancel Requested ainda podem ser executadas, dependendo do estado de execução atual do agente.

  • 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 um painel que permite reordenar as colunas ou ajustar sua visibilidade no painel de lista de operações:

    filter columns

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

    • Mover: Arraste e solte para alterar 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 exibi-la.

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

  • Log de operação: Para mostrar ou ocultar um log de uma operação individual, clique em uma operação da lista.

    • Mensagens de log: As mensagens de log incluem os detalhes do log da operação selecionada. Se as mensagens de log são exibidas depende das permissões e níveis de acesso do usuário atual e se o log em nuvem está ativado. Para mais informações, consulte Aba Mensagens anteriormente nesta página.

      Nota

      As datas e horas exibidas nas próprias mensagens de log 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 log.

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

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

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 log de depuração de operação ativado no nível da operação (para agentes em nuvem ou para agentes privados) e a operação foi executada em um agente versão 10.48 ou posterior.

Nota

A geração de dados de entrada e saída do componente não é afetada pela configuração do grupo de agentes Log em nuvem ativado. Os dados de entrada e saída do componente serão registrados na nuvem Harmony mesmo que o log em nuvem esteja desativado.

Para desativar a geração de dados de entrada e saída do componente em um grupo de agentes privados, no arquivo de configuração do agente privado na seção [VerboseLogging], defina verbose.logging.enable=false.

Aviso

Quando dados de entrada e saída do componente são gerados, todos os dados de solicitação e resposta dessa operação são registrados na nuvem Harmony e permanecem lá por 30 dias. Tenha cuidado pois informações de identificação pessoal (PII) e dados sensíveis, como credenciais fornecidas em uma carga de solicitação, estarão visíveis em texto claro nos dados de entrada e saída nos logs da nuvem Harmony.

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

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

log table operation steps header

  • Pesquisar: Pesquise nos dados pelo texto inserido.
  • Copiar: Copia os dados de 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 de operação seguido por _input ou _output conforme apropriado.

Dados de solicitação e resposta da API

Quando uma operação é acionada por uma API personalizada do API Manager ou API OData, as informações exibidas nos detalhes da entrada de log da Aba Mensagens dependem de quais configurações estão ativadas. Informações de API, informações de chamada e dados básicos de log de chamada sempre são inclusos. indica que o tipo de informação está incluído; indica que não está:

Configurações ativadas Informações da API Informações de chamada Dados brutos de solicitação e resposta Cargas de solicitação/resposta Entradas do log de operação
Nenhuma (padrão)
Log detalhado (configurações de API personalizada, API OData ou API proxy)
Mostrar cargas de solicitação e resposta nos logs (configurações de API personalizada ou API OData)
Ativar modo de depuração até (configurações de API personalizada, API OData ou API proxy) — substitui Log detalhado e Mostrar cargas de solicitação e resposta nos logs
Log de depuração de operação (agentes em nuvem ou agentes privados)
Também registra na guia Debug Logging

Cabeçalhos mascarados

Os cabeçalhos que normalmente contêm credenciais ou dados de sessão são mascarados na saída do log. O nome do cabeçalho mascarado ainda é exibido, mas seu valor é substituído por [removed].

O mascaramento se aplica à seção Informações de chamada nesta página, à seção Informações de chamada da página Runtime do Console de Gerenciamento e aos dados brutos de solicitação e resposta adicionados por Log detalhado ou Ativar modo de depuração até.

Os seguintes cabeçalhos são mascarados:

  • api_key
  • authorization
  • authtoken
  • clientsecret
  • password
  • proxy_authorization
  • x_access_token
  • x_api_key
  • x_auth_token

Nota

O mascaramento é aplicado pelo gateway de API em nuvem e pelo gateway de API privada versão 12.9 ou posterior. Nas versões anteriores do gateway de API privada, os valores desses cabeçalhos são exibidos na íntegra.

Aviso

O mascaramento cobre apenas os cabeçalhos listados acima. Os dados sensíveis em outros cabeçalhos, em cargas de solicitação ou resposta, ou em mensagens de log são exibidos na íntegra.

Para mascarar cabeçalhos de solicitação personalizados em atividades HTTP do Studio ou fontes e destinos HTTP do Design Studio, use a seção [Masking] do arquivo de configuração do agente privado.

API Manager Log Service API (Beta)

Como alternativa para baixar um arquivo de log de API clicando em Baixar como CSV, você pode recuperar logs de API programaticamente usando a API Manager Log Service API (Beta).

Solução de problemas

Para a solução de problemas relacionada, consulte o seguinte no guia de solução de problemas do API Manager: