Ir para o conteúdo

Registro Detalhado para Conectores

Introdução

O registro detalhado do conector pode ser usado na solução de problemas com determinados Cloud Studio conectores quando usados com agentes privados. O suporte do Jitterbit pode solicitar que você habilite o registro detalhado do conector seguindo as etapas nesta página.

Nota

As etapas aqui devem ser usadas somente quando orientadas pelo suporte da Jitterbit.

O registro detalhado do conector é compatível com determinados conectores do Cloud Studio, cada um com seu próprio nome do conector de registro detalhado que deve ser inserido conforme descrito em Ativar o registro detalhado mais adiante nesta página.

Para conectores que suportam o registro verboso do conector, o nome específico do conector de registro verboso a ser usado é descrito em a documentação de cada conector.

Habilitar Registro Detalhado

A ativação do log detalhado do conector requer acesso a cada agente privado em um grupo de agentes, pois o log detalhado não é habilitado por padrão. Cada agente deve ter um arquivo de propriedades editado para permitir a criação de log detalhado.

Há um procedimento diferente para ativar o log detalhado dependendo da versão do agente. A versão de um agente privado pode ser determinada através do Management Console Agents página.

Versão do Agente 10.70/11.8 e Posterior: Editar logback.xml

Importante

A localização do logback.xml o arquivo é diferente nas versões 10.70 / 11.8 e posteriores dos agentes privados do que nas versões anteriores. Ao atualizar de uma versão do agente que seja pelo menos 10.35, para manter as entradas de log verbose existentes, você pode copiar o arquivo de seu local existente para o novo local definido abaixo.

Para editar o logback.xml arquivo:

  1. Faça um backup de todos os arquivos que você irá editar.

  2. Pare o agente:

  3. Encontre o logback.xml arquivo, conforme determinado pelo sistema operacional e pela localização do diretório inicial do Jitterbit:

    • Linux: /opt/jitterbit/tomcat/shared/lib/logback.xml
    • Windows: C:\Program Files\Jitterbit Agent\tomcat\shared\lib\logback.xml

  4. Abra o logback.xml arquivo em um editor.

  5. Encontre as linhas:

    . . .
  <logger name="org.springframework" level="WARN"/>
  <logger name="org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl" level="ERROR"/>
. . .

  6. Após essas linhas adicione uma das seguintes linhas, substituindo <connector_name> com o nome de registro detalhado do conector e defina o nível de registro. Veja a documentação do conector individual para o formato de nomenclatura apropriado, <connector_name>, e nível de registro.

    Nomes de registro detalhados estão em um destes formatos, dependendo do conector específico:

      <logger name="org.jitterbit.connector.<connector_name>" level="DEBUG"/>

      <logger name="org.jitterbit.connector.verbose.logging.<connector_name>" level="DEBUG"/>

    Usando o conector Workday Prism Analytics como exemplo, seu nome de registro detalhado é workdayprismanalytics (encontrado na documentação do conector Workday Prism Analytics). Este deve ser o snippet do arquivo logback:

    . . .
  <logger name="org.springframework" level="WARN"/>
  <logger name="org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl" level="ERROR"/>
  <logger name="org.jitterbit.connector.verbose.logging.workdayprismanalytics" level="DEBUG"/>
. . .

    Nota

    O registro detalhado pode ser usado com vários conectores. Adicione uma linha separada para cada conector.

  7. Salve o arquivo e reinicie o agente:

Versão do Agente 10.35 a 10.69/11.7: Editar logback.xml

Para editar o logback.xml arquivo:

  1. Faça um backup de todos os arquivos que você irá editar.

  2. Pare o agente:

  3. Encontre o logback.xml arquivo, conforme determinado pelo sistema operacional e pela localização do diretório inicial do Jitterbit:

    • Linux: /opt/jitterbit/tomcat/webapps/axis/WEB-INF/lib/logback.xml
    • Windows: C:\Program Files\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\logback.xml

  4. Abra o logback.xml arquivo em um editor.

  5. Encontre as linhas:

    . . .
  <logger name="org.springframework" level="WARN"/>
  <logger name="org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl" level="ERROR"/>
. . .

  6. Após essas linhas adicione uma das seguintes linhas, substituindo <connector_name> com o nome de registro detalhado do conector e defina o nível de registro. Veja a documentação do conector individual para o formato de nomenclatura apropriado, <connector_name>, e nível de registro.

    Nomes de registro detalhados estão em um destes formatos, dependendo do conector específico:

      <logger name="org.jitterbit.connector.<connector_name>" level="DEBUG"/>

      <logger name="org.jitterbit.connector.verbose.logging.<connector_name>" level="DEBUG"/>

    Usando o conector Workday Prism Analytics como exemplo, seu nome de registro detalhado é workdayprismanalytics (encontrado na documentação do conector Workday Prism Analytics). Este deve ser o snippet do arquivo logback:

    . . .
  <logger name="org.springframework" level="WARN"/>
  <logger name="org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl" level="ERROR"/>
  <logger name="org.jitterbit.connector.verbose.logging.workdayprismanalytics" level="DEBUG"/>
. . .

    Nota

    O registro detalhado pode ser usado com vários conectores. Adicione uma linha separada para cada conector.

  7. Salve o arquivo e reinicie o agente:

Agente Versão 10.34 e Anteriores: Editar log4j.properties

Para editar o log4j.properties arquivo:

  1. Faça um backup de todos os arquivos que você irá editar.

  2. Pare o agente:

  3. Encontre o log4j.properties arquivo, conforme determinado pelo sistema operacional e pela localização do diretório inicial do Jitterbit:

    • Linux: /opt/jitterbit/tomcat/webapps/axis/WEB-INF/lib/log4j.properties
    • Windows: C:\Program Files\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\log4j.properties

  4. Abra o log4j.properties arquivo em um editor.

  5. Encontre estas linhas:

    . . .
log4j.logger.org.springframework=WARN
log4j.logger.org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl=ERROR

# Debug options can be turned on by uncommenting these lines
# . . .

  6. Logo antes da linha que começa com # Debug, adicione uma das seguintes linhas, substituindo <connector_name> com o nome de registro detalhado do conector e defina o nível de registro. Veja a documentação do conector individual para o formato de nomenclatura apropriado, <connector_name>, e nível de registro.

    Nomes de registro detalhados estão em um destes formatos, dependendo do conector específico:

    log4j.logger.org.jitterbit.connector.<connector_name>=DEBUG

    log4j.logger.org.jitterbit.connector.verbose.logging.<connector_name>=DEBUG

    Usando o conector Workday Prism Analytics como exemplo, seu nome de registro detalhado é workdayprismanalytics (encontrado na documentação do conector Workday Prism Analytics). Este deve ser o snippet do arquivo de propriedade:

    . . .
log4j.logger.org.springframework=WARN
log4j.logger.org.hibernate.engine.jdbc.internal.JdbcResourceRegistryImpl=ERROR
log4j.logger.org.jitterbit.connector.verbose.logging.workdayprismanalytics=DEBUG

# Debug options can be turned on by uncommenting these lines
# . . .

    Nota

    O registro detalhado pode ser usado com vários conectores. Adicione uma linha separada para cada conector.

  7. Salve o arquivo de propriedades e reinicie o agente:

Desabilitar Registro Detalhado

Para desativar o log detalhado para um conector quando ele não for mais necessário, edite o arquivo apropriado que foi editado originalmente para ativar o log detalhado. Você pode deixar as entradas no arquivo e simplesmente desativar o nível de log.

  1. Faça um backup de todos os arquivos que você irá editar.

  2. Pare o agente:

  3. Vá para o arquivo de propriedades apropriado conforme descrito acima para sua versão do agente e abra-o em um editor.

  4. Encontre a linha que contém as informações de log detalhadas para o conector específico e altere o sinalizador de DEBUG para OFF.

    • Usando o Workday Prism Analytics em um log4j.properties arquivo como exemplo, altere:

      log4j.logger.org.jitterbit.connector.verbose.logging.workdayprismanalytics=DEBUG

      para

      log4j.logger.org.jitterbit.connector.verbose.logging.workdayprismanalytics=OFF

    • Usando o Workday Prism Analytics em um logback.xml arquivo como exemplo, altere:

        <logger name="org.jitterbit.connector.verbose.logging.workdayprismanalytics" level="DEBUG"/>

      para

        <logger name="org.jitterbit.connector.verbose.logging.workdayprismanalytics" level="OFF"/>

  5. Salve o arquivo e reinicie o agente:

Exibir Logs Detalhados

Quando o registro detalhado está habilitado, as entradas são gravadas no jitterbit-axis.log arquivo. Abra o arquivo de log em um editor para visualizar as entradas. O arquivo de log é salvo nestes locais, dependendo do sistema operacional e da versão do agente:

  • Linux: /opt/jitterbit/log/jitterbit-axis.log
  • Windows: C:\Program Files\Jitterbit Agent\log\jitterbit-axis.log

Para encontrar entradas, pesquise os termos INFO, DEBUG, ou VerboseLogger no arquivo. As entradas podem incluir mensagens, esquemas e outras informações que podem ser usadas na depuração. Um trecho é mostrado aqui:

2020-12-07 15:06:31,445 +0530 http-nio-127.0.0.1-46912-exec-9 DEBUG org.jitterbit.connector.verbose.logging.epicorerp.VerboseLogger:22 - org.jitterbit.connector.epicor.EpicorClient.PATCH, msg: {"method: ":"PATCH","headers: ":"Authorization: Basic bWFuYWdlcjomd1I3aWk1IQ==\nkeep-alive: true\n","URI: ":"https://sample.developer.epicor.com/%2Fserver%2Fapi%2Fv1/BaqSvc/PartsAdvancedBPM","requestPayload: ":"{\"Part_Company\":\"EPIC01\",\"SysRowID\":\"470bf6e7-cba1-4a7b-6ee7-a33b015c3cbc\",\"Part_PartNum\":\"001_MPCons\",\"Part_UserDecimal1\":\"0\"}"}
2020-12-07 15:06:31,742 +0530 http-nio-127.0.0.1-46912-exec-9 DEBUG org.jitterbit.connector.verbose.logging.epicorerp.VerboseLogger:22 - org.jitterbit.epicor.adapter.common.CommonResponseGenerator.statusCode, msg: 200
2020-12-07 15:06:31,742 +0530 http-nio-127.0.0.1-46912-exec-9 DEBUG org.jitterbit.connector.verbose.logging.epicorerp.VerboseLogger:22 - org.jitterbit.epicor.adapter.common.CommonResponseGenerator.responsePayload, msg: {
  "odata.metadata":"https://sample.developer.epicor.com/server/api/v1/BaqSvc/PartsAdvancedBPM/$metadata#Epicor.DynamicQuery.QueryResults","value":[
    {
      "Part_Company":"EPIC06","Part_PartNum":"001_MPCons","Part_UserChar1":"","Part_UserDecimal1":"0","RowMod":"","RowIdent":"38ca34b4-2440-4d3d-ac3b-177b610f01ac","SysRowID":"470bf6e7-cba1-4a7b-6ee7-a33b015c3cbc"
    }
  ]
}

Informações Adicionais de Log

Conectores usando o org.jitterbit.connector.<connector_name> formato de nome de registro detalhado inclui certas informações no arquivo de registro quando definido como DEBUG nível de registro:

  • Chamadas HTTP: Chamadas HTTP do conector.

    • URL: O URL associado à chamada, incluindo qualquer consultar e parâmetros de caminho, se presentes.
    • Cabeçalhos de solicitação: Cabeçalhos de solicitação associados à chamada. Por questões de segurança, cabeçalhos que contenham determinadas informações, como a passada em um cabeçalho de autorização, terão seus valores mascarados com asteriscos.
    • Cabeçalhos de resposta: Cabeçalhos de resposta associados à chamada.
    • Método HTTP: O método HTTP associado à chamada, um dos HEAD, GET, POST, PUT, PATCH, DELETE, OPTIONS, CONNECT, ou TRACE.
    • Tempo de Resposta: O tempo de resposta da chamada em milissegundos.
    • Corpo da solicitação: O corpo da solicitação associado à chamada, se presente.
    • Corpo da resposta: O corpo da resposta associado à chamada, se presente.
    • Código de status HTTP: O código de status HTTP associado à chamada.

  • Mensagens de solução de problemas: Mensagens de log adicionais para ajudar na solução de problemas do conector.

As mensagens de registro também incluirão o ID da organização Harmony e ID do ambiente associado ao projeto como orgId e envId respectivamente:

2023-05-07 18:13:42 http-nio-127.0.0.1-46912-exec-6 DEBUG org.jitterbit.connector.<connector_name>.Connection:80 [orgId:-][ID do ambiente: 100000] - Closing connection
2023-05-07 18:13:42 http-nio-127.0.0.1-46912-exec-6 DEBUG org.jitterbit.connector.<connector_name>.client.Client:80 [orgId:-][ID do ambiente: 100000] - Connection is closing...

Nota

É possível que mensagens de log contenham um ID de organização indefinido ([orgId:-]) se as mensagens forem registradas fora do tempo de execução da operação. Por exemplo, ao testar a configuração de conexão de um conector.