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

Introdução

Os registros de depuração de operações são arquivos de log e dados adicionais gerados para operações quando o registro de depuração de operações está habilitado.

Em agentes privados, habilitar o registro de depuração de operações pode resultar na geração de três tipos de logs:

• Arquivos de log de depuração de operações: Arquivos escritos em um diretório de agente privado que são gerados quando o registro de depuração de operações está habilitado, seja em uma operação individual do Integration Studio ou Design Studio, ou para todas as operações em um agente privado através do arquivo de configuração do agente. Os arquivos são acessíveis diretamente nos agentes privados e podem ser baixados através das páginas Agentes e Operações em Tempo de Execução do Console de Gerenciamento. Os arquivos estão sujeitos à política de retenção configurada nas regras de limpeza do agente, que é de 1 dia por padrão.

• Dados de entrada e saída de componentes: Dados escritos em um log de operação do Integration Studio quando o registro de depuração de operações está habilitado em uma operação do Integration Studio executando em um agente privado 10.48 ou posterior. Os dados são retidos por 30 dias pela Harmony.

  Warning

  Quando 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. Esteja ciente de que 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.

• Logs de Operação da API: Logs de operação para operações de API bem-sucedidas e malsucedidas (configuradas para APIs personalizadas ou serviços OData). Quando o registro de depuração de operações não está habilitado, apenas operações de API malsucedidas são registradas nos logs de operação.

  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 API Operation.

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. Dados de entrada e saída de componentes 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 tendo 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 Integration Studio ou opções de operação do Design Studio:

• Integration 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 de 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 será desativado no início desta data (ou seja, às 12:00 am) usando o fuso horário do agente.

Entire private agent

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

Para ativar 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.

Additional settings

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 é automaticamente habilitada 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 desativar 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.

Operation debug log files

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

Acesso ao arquivo 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 Operações em Tempo de Execução do Console de Gerenciamento, ou diretamente no host do agente nos seguintes locais:

Para alterar o diretório do 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 pode ser acessado em agentes privados nesses locais padrão:

Dentro do arquivo CleanupRules.xml, você pode editar essa regra de limpeza para alterar a política de retenção dos arquivos de log 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

Os dados de entrada e saída do componente são gerados quando uma operação do Integration Studio que tem registro de depuração da operação habilitado no nível da operação é executada em um agente privado 10.48 ou posterior que também possui as configurações de configuração padrão. Os dados de entrada e saída estão disponíveis apenas para atividades e transformações usadas como etapas da operação.

Input and output data access

Os dados de entrada e saída do componente são acessados a partir da tela de registro de operações do Integration Studio ou na página de Operações em Tempo de Execução do Console de Gerenciamento, em linhas de tabela adicionais mostradas para cada etapa da operação que possui dados de entrada e saída. Na coluna Input/Output, ícones para atividades e transformações usadas como etapas da operação podem ser clicados para mostrar ou ocultar os dados de entrada e saída do componente para essa etapa individual da operação. Cada entrada de log de entrada e saída é limitada a 100MB. Se os dados de uma entrada de log de entrada ou saída individual excederem 100MB, nenhum dado será exibido.

• Search: Pesquisar os dados pelo texto inserido.
• Copy: Copia os dados do log para a sua área de transferência.
• Download: 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.

Input and output data retention policy

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

Input and output data contents

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 esses componentes usados como etapas de 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.

Dados de entrada e saída não se aplicam a scripts quando são usados como etapas de 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 na 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.