Ir para o conteúdo

Registro de depuração de operações para agentes privados Jitterbit

Introdução

O registro de depuração de operações gera informações diagnósticas adicionais para ajudar na resolução de problemas. Este recurso produz três tipos de logs:

  • Arquivos de log de depuração de operações: Mensagens de depuração para cada atividade de operação, incluindo informações registradas antes e depois da execução de cada transformação. Os arquivos são gravados no agente privado e estão sujeitos à política de retenção configurada nas regras de limpeza do agente (1 dia por padrão).

  • Dados de entrada e saída de componentes: Os dados de solicitação e resposta processados por cada atividade e transformação em uma operação. Esses dados estão disponíveis para operações executadas em agentes privados versão 10.48 ou posterior. O Harmony retém esses dados por 30 dias.

  • Dados de solicitação da API: Informações detalhadas sobre chamadas de API para operações acionadas por um API personalizada do Gerenciador de API ou API OData, incluindo nome da API, método de solicitação, IP de origem, detalhes do gateway e dados de rastreamento de chamadas. Para detalhes sobre quando esses dados aparecem nos logs, consulte Dados de solicitação da API.

Aviso

Quando os dados de entrada e saída de componentes são gerados, todos os dados de solicitação e resposta para essa operação são registrados na nuvem Harmony e permanecem lá por 30 dias. Informações pessoalmente identificáveis (PII) e dados sensíveis, como credenciais fornecidas em um payload de solicitação, estarão visíveis em texto claro nos dados de entrada e saída nos logs da nuvem Harmony.

Devido a essas implicações de segurança, use o registro de depuração de operações apenas para depurar problemas durante os testes. Não ative esse recurso em um ambiente de produção. Os arquivos de log de depuração gerados podem ser grandes em quantidade e/ou tamanho.

Nota

Os passos para habilitar o registro de todas as operações da API para todo o agente diferem dos passos descritos em Agente privado inteiro mais adiante nesta página. Para informações sobre como habilitar o registro de operações da API para todo o agente, consulte Operação da API.

Habilitar registro de depuração de operações

O registro de depuração de operações pode ser habilitado em uma operação individual ou em um agente privado inteiro. Os dados de entrada e saída do componente são gerados por padrão em agentes privados 10.48 ou posteriores, mas podem ser desativados usando configurações adicionais no arquivo de configuração do agente privado.

Operação individual

O registro de depuração em nível de operação pode ajudar se você estiver enfrentando problemas com uma operação individual e não precisar ativar o registro de depuração no nível do agente, o que pode gerar arquivos que são grandes em quantidade e/ou tamanho.

Você pode habilitar o registro de depuração para uma operação individual usando opções de operação do Studio ou opções de operação do Design Studio:

  • Studio: Use o menu de ações de uma operação para selecionar Configurações. Na aba Opções, selecione Habilitar Registro de Depuração Até e defina uma data para que o registro de depuração seja desativado. A opção de propagar as configurações do modo de depuração para quaisquer operações filhas também está disponível.

  • Design Studio: Clique com o botão direito no fundo de qualquer operação e selecione Opções. Na janela Opções da Operação, selecione Habilitar Modo de Depuração Até e defina uma data para que o registro de depuração seja desativado.

Esta data é limitada a 2 semanas a partir da data atual. O registro de depuração de operações é desativado no início desta data (ou seja, às 12:00 am) usando o fuso horário do agente.

Agente privado inteiro

O registro de depuração de operações em nível de agente pode ser habilitado a partir do arquivo de configuração do agente privado para todas as operações em execução em um agente privado.

Cuidado

Habilitar o registro de depuração no nível do agente pode criar arquivos muito grandes no diretório de cada agente privado dentro do grupo de agentes privados. Se você estiver enfrentando problemas com uma operação individual, considere habilitar o registro de depuração para uma operação individual em vez disso.

Para habilitar o registro de depuração, edite o arquivo de configuração do agente privado da seguinte forma e, em seguida, reinicie os serviços do Jitterbit.

  • Na seção [TransformationEngine], defina WriteLog=true.

  • Na seção [OperationEngine], defina Debug=true.

Os arquivos criados neste diretório podem se tornar muito grandes. Desative o registro de depuração assim que puder e exclua os arquivos quando não forem mais necessários.

Configurações adicionais

Agentes privados que são da versão 10.48 ou posterior têm a seção [VerboseLogging] presente em seu arquivo de configuração do agente privado com a configuração verbose.logging.enable=true, que habilita a geração de dados de entrada e saída de componentes:

[VerboseLogging]
verbose.logging.enable=true

Ao atualizar uma versão anterior do agente privado para 10.48 ou posterior, a geração de dados de entrada e saída é habilitada automaticamente por padrão, mesmo que a seção [VerboseLogging] e a configuração verbose.logging.enable não estejam presentes no arquivo de configuração.

Para desabilitar a geração de dados de entrada e saída de componentes, você deve adicionar a seção [VerboseLogging] e definir verbose.logging.enable=false para impedir que os dados de entrada e saída de componentes sejam registrados na nuvem Harmony.

Configurações adicionais na seção [VerboseLogging] não devem ser alteradas, a menos que instruído pelo suporte do Jitterbit.

Visualizar logs de operação

A localização onde você visualiza os logs de operação depende do tipo de log gerado:

  • Arquivos de log de depuração de operação: Acesse através do ícone Baixar logs do agente na página Agentes do Console de Gerenciamento, na aba Arquivos de Depuração da página Runtime do Console de Gerenciamento, ou diretamente no host do agente. Para detalhes, veja Acesso ao arquivo de log de depuração.

  • Dados de entrada e saída de componentes e dados de solicitação de API: Visualize nos logs de operação do Studio a partir do menu Visualizar Logs da operação ou na página Runtime do Console de Gerenciamento.

Arquivos de log de depuração da operação

Uma vez que o registro de depuração da operação é ativado em uma operação do Studio, operação do Design Studio ou em um agente privado inteiro, arquivos de log de depuração da operação para as operações aplicáveis são gerados quando essas operações são executadas.

Acesso aos arquivos de log de depuração

Os arquivos de log de depuração da operação podem ser acessados através do ícone Baixar logs do agente na página Agentes do Console de Gerenciamento, na aba Arquivos de depuração da página Runtime do Console de Gerenciamento, ou diretamente no host do agente nos seguintes locais:

C:\Program Files\Jitterbit Agent\DataInterchange\Temp\Debug

/usr/local/jitterbit/DataInterchange/Temp/Debug

Para alterar o diretório de log de depuração da operação, edite o arquivo de configuração do agente privado da seguinte forma e, em seguida, reinicie os serviços do Jitterbit:

  • Na seção [TransformationEngine], defina WriteLogDir para o local do diretório desejado.

Política de retenção de arquivos de log de depuração

Por padrão, os arquivos de log de depuração da operação são excluídos automaticamente após 1 dia.

Esse período de tempo é configurável no CleanupRules.xml, que é acessível em agentes privados nesses locais padrão:

C:\Program Files\Jitterbit Agent

/usr/local/jitterbit/

Dentro do arquivo CleanupRules.xml, você pode editar essa regra de limpeza para alterar a política de retenção dos logs de depuração da operação:

  <CleanupRule>
      <DirectoryPath SearchSubDirectory = "YES" >DataInterchange/Temp/Debug</DirectoryPath>
      <Pattern>*</Pattern>
      <FileAge NumDays = "1" Comparator = "GE"/>
      <FileSize Size = "0" Comparator = "GE"/>
  </CleanupRule>

Conteúdo dos arquivos de log de depuração

Os arquivos de log de depuração da operação contêm mensagens de depuração para cada atividade da operação e incluem informações que são registradas antes e depois que cada transformação é executada. Informações sobre outras ações, como leitura e gravação no cache do Harmony, também estão incluídas.

Esses arquivos são tipicamente solicitados pelo suporte do Jitterbit se mais informações forem necessárias durante a resolução de problemas.

Dados de entrada e saída do componente

Pré-requisitos

Os dados de entrada e saída do componente são gerados quando todas as seguintes condições são atendidas:

Cuidado

A geração de dados de entrada e saída do componente não é afetada pela configuração do grupo de agentes Registro em nuvem habilitado. Os dados de entrada e saída do componente serão registrados na nuvem Harmony, mesmo que o registro em nuvem esteja desabilitado.

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

Dados de entrada e saída

Os dados de entrada e saída estão disponíveis apenas para atividades e transformações usadas como etapas de operação.

Os dados de entrada e saída do componente são acessados a partir da tela de registro de operações do Studio ou da página Runtime do Console de Gerenciamento em linhas de tabela adicionais mostradas para cada etapa de operação que possui dados de entrada e saída. No painel esquerdo, ícones para atividades e transformações usadas como etapas de operação são exibidos. Você pode clicar em uma etapa de operação para mostrar ou ocultar os dados de entrada e saída do componente para essa etapa de operação individual. Cada entrada de registro de entrada e saída é limitada a 100 MB. Se os dados de uma entrada de registro de entrada ou saída individual excederem 100 MB, nenhum dado será exibido.

tabela de registros cabeçalho das etapas de operação

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

Política de retenção de dados de entrada e saída

Os dados de entrada e saída do componente são retidos por 30 dias pelo Harmony.

Conteúdos dos dados de entrada e saída

Os dados de entrada e saída do componente são gerados para certas etapas de uma operação. Os dados são apropriados à função de uma etapa. A entrada é a estrutura que o componente consome, enquanto a saída é a estrutura que o componente produz.

Os dados de entrada e saída são gerados para estes componentes usados como etapas da operação:

  • Atividades: Dados de entrada e saída e qualquer informação relacionada à execução da atividade. Algumas atividades podem ter múltiplos arquivos de entrada e saída.

  • Transformações: Dados de entrada e saída para a execução da transformação.

Os dados de entrada e saída não se aplicam a scripts quando você os utiliza como etapas da operação. O conteúdo do script, como o produzido pela função WritetoOperationLog, é exibido nas mensagens de log de um log de operação.

Solução de problemas de dados de entrada e saída

Os logs do agente relacionados aos dados de entrada e saída normalmente não precisam ser acessados. Se você achar que pode haver um problema com a geração dos dados de entrada e saída, pode verificar os arquivos de log do serviço Verbose Log Shipper em um agente privado:

<JITTERBIT_HOME>/VerboseLogShipper/verbose-log-shipper.out.log

O serviço Verbose Log Shipper pode ser reiniciado reiniciando um agente privado.

Em agentes privados Linux, você também pode desativar e reativar este serviço usando estas opções de linha de comando do Jitterbit:

jitterbit start verboselogshipper

jitterbit stop verboselogshipper

Essas opções também podem ser visualizadas usando jitterbit --help.

Dados de solicitação da API

Nova interface de Análise necessária

O recurso de dados de solicitação da API está disponível apenas para organizações que foram atualizadas para a nova interface de Análise. Esta atualização está sendo implementada gradualmente. Se você estiver interessado em acesso antecipado, entre em contato com o suporte do Jitterbit.

Quando uma operação é acionada por um API Manager ou OData API, a quantidade de informações exibidas nos logs de operação depende das configurações que estão habilitadas:

Configurações habilitadas Informações registradas Como habilitar
Nenhuma (padrão)
  • Apenas operações malsucedidas no logs de operação do Studio.
  • Operações bem-sucedidas e malsucedidas com informações de solicitação da API na página Runtime do Console de Gerenciamento.
 Este é o comportamento padrão.
Registro de depuração de operação Operações bem-sucedidas e malsucedidas com informações de solicitação da API nos logs de operação do Studio e na página Runtime do Console de Gerenciamento. O payload de solicitação e resposta é excluído.
Registro de depuração de operação e registro detalhado da API Operações bem-sucedidas e malsucedidas com informações de solicitação da API nos logs de operação do Studio e na página Runtime do Console de Gerenciamento, incluindo payload de solicitação e resposta. Habilite o registro de depuração de operação para agente em nuvem ou agentes privados, e no API Manager, habilite Registro detalhado na aba Configurações da API.

informações da API

Informações da API

O log de operações pode exibir as seguintes informações para chamadas de API:

  • Informações da API: Detalhes sobre a chamada da API, incluindo nome da API, tipo de API, método de solicitação, ID da solicitação da API, IP de origem, gateway da API, URL do serviço da API e aplicativo de origem. Para descrições dos campos, veja Informações da API.

  • Informações da chamada: Os cabeçalhos da solicitação HTTP enviados com a chamada da API, como accept, accept_encoding, content_length, fulluri, host, user_agent e cabeçalhos de encaminhamento.

  • Log da chamada: Informações de rastreamento sobre o processamento da solicitação da API.