Skip to Content

Verbose Logging for Connectors

Introduction

Connector verbose logging can be used in troubleshooting issues with certain Cloud Studio connectors when used with Private Agents. You may be asked by Jitterbit Support to enable connector verbose logging by following the steps on this page.

Note

The steps here should be used only when directed by Jitterbit Support.

Connector verbose logging is supported for certain Cloud Studio connectors, each with its own verbose logging connector name that must be entered as described in Enabling Verbose Logging later on this page.

For connectors that support connector verbose logging, the specific verbose logging connector name to use is described in each connector's documentation.

Enable Verbose Logging

Enabling connector verbose logging requires access to each Private Agent in an Agent Group, as verbose logging is not enabled by default. Each agent must have a properties file edited to enable verbose logging.

There is a different procedure for enabling verbose logging depending on the version of the agent. A Private Agent's version can be determined through the Management Console.

Agent Version 10.70 / 11.8 and Later: Edit logback.xml

Important

The location of the logback.xml file is different in Private Agents version 10.70 / 11.8 and later than it is in prior versions. When upgrading from an agent version that is at least 10.35, to keep existing verbose logging entries, you can copy the file from its existing location to the new location defined below.

To edit the logback.xml file:

  1. Make a backup of any files you are going to edit.

  2. Stop the agent:

  3. Find the logback.xml file, as determined by the operating system and the location of Jitterbit home directory:

    • Linux: /opt/jitterbit/tomcat/shared/lib/logback.xml
    • Windows with a 32-bit Private Agent: C:\Program Files (x86)\Jitterbit Agent\tomcat\shared\lib\logback.xml
    • Windows with a 64-bit Private Agent: C:\Program Files\Jitterbit Agent\tomcat\shared\lib\logback.xml

  4. Open the logback.xml file in an editor.

  5. Find the lines:

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

  6. After those lines add one of the following lines, replacing <connector_name> with the verbose logging name of the connector and set the logging level. See the individual connector documentation for the appropriate naming format, <connector_name>, and logging level.

    Verbose logging names are in one of these formats, depending on the specific connector:

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

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

    Using the Workday Prism Analytics connector as an example, its verbose logging name is workdayprismanalytics (found in the Workday Prism Analytics connector documentation). This should then be the logback file snippet:

    . . .
  <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"/>
. . .

    Note

    Verbose logging can be used with multiple connectors. Add a separate line for each connector.

  7. Save the file and restart the agent:

Agent Version 10.35 to 10.69 / 11.7: Edit logback.xml

To edit the logback.xml file:

  1. Make a backup of any files you are going to edit.

  2. Stop the agent:

  3. Find the logback.xml file, as determined by the operating system and the location of Jitterbit home directory:

    • Linux: /opt/jitterbit/tomcat/webapps/axis/WEB-INF/lib/logback.xml
    • Windows with a 32-bit Private Agent: C:\Program Files (x86)\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\logback.xml
    • Windows with a 64-bit Private Agent: C:\Program Files\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\logback.xml

  4. Open the logback.xml file in an editor.

  5. Find the lines:

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

  6. After those lines add one of the following lines, replacing <connector_name> with the verbose logging name of the connector and set the logging level. See the individual connector documentation for the appropriate naming format, <connector_name>, and logging level.

    Verbose logging names are in one of these formats, depending on the specific connector:

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

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

    Using the Workday Prism Analytics connector as an example, its verbose logging name is workdayprismanalytics (found in the Workday Prism Analytics connector documentation). This should then be the logback file snippet:

    . . .
  <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"/>
. . .

    Note

    Verbose logging can be used with multiple connectors. Add a separate line for each connector.

  7. Save the file and restart the agent:

Agent Version 10.34 and Earlier: Edit log4j.properties

To edit the log4j.properties file:

  1. Make a backup of any files you are going to edit.

  2. Stop the agent:

  3. Find the log4j.properties file, as determined by the operating system and the location of Jitterbit home directory:

    • Linux: /opt/jitterbit/tomcat/webapps/axis/WEB-INF/lib/log4j.properties
    • Windows with a 32-bit Private Agent: C:\Program Files (x86)\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\log4j.properties
    • Windows with a 64-bit Private Agent: C:\Program Files\Jitterbit Agent\tomcat\webapps\axis\WEB-INF\lib\log4j.properties

  4. Open the log4j.properties file in an editor.

  5. Find these lines:

    . . .
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. Just before the line starting with # Debug, add one of the following lines, replacing <connector_name> with the verbose logging name of the connector and set the logging level. See the individual connector documentation for the appropriate naming format, <connector_name>, and logging level.

    Verbose logging names are in one of these formats, depending on the specific connector:

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

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

    Using the Workday Prism Analytics connector as an example, its verbose logging name is workdayprismanalytics (found in the Workday Prism Analytics connector documentation). This should then be the property file snippet:

    . . .
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
# . . .

    Note

    Verbose logging can be used with multiple connectors. Add a separate line for each connector.

  7. Save the properties file and restart the agent:

Disable Verbose Logging

To disable verbose logging for a connector when it is no longer needed, edit the appropriate file that was originally edited to enable verbose logging. You can leave the entries in the file and simply set the log level to off.

  1. Make a backup of any files you are going to edit.

  2. Stop the agent:

  3. Go to the appropriate properties file as described above for your agent version and open it in an editor.

  4. Find the line that contains the verbose logging information for the specific connector and change the flag from DEBUG to OFF.

    • Using Workday Prism Analytics in a log4j.properties file as an example, change:

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

      to

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

    • Using Workday Prism Analytics in a logback.xml file as an example, change:

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

      to

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

  5. Save the file and restart the agent:

View Verbose Logs

When verbose logging is enabled, entries are written to the jitterbit-axis.log file. Open the log file in an editor to view the entries. The log file is saved in these locations, depending on the operating system and agent version:

  • Linux: /opt/jitterbit/log/jitterbit-axis.log
  • Windows with a 32-bit Private Agent: C:\Program Files (x86)\Jitterbit Agent\log\jitterbit-axis.log
  • Windows with a 64-bit Private Agent: C:\Program Files\Jitterbit Agent\log\jitterbit-axis.log

To find entries, search for the terms INFO, DEBUG, or VerboseLogger in the file. Entries may include messaging, schemas, and other information that can be used when debugging. An excerpt is shown here:

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"
    }
  ]
}

Additional Log Information

Connectors using the org.jitterbit.connector.<connector_name> verbose logging name format include certain information in the log file when set to the DEBUG logging level:

  • HTTP Calls: HTTP calls from the connector.

    • URL: The URL associated with the call including any query and path parameters if present.
    • Request Headers: Request headers associated with the call. For security purposes, headers that contain certain information, such as that passed in an authorization header, will have their values masked with asterisks.
    • Response Headers: Response headers associated with the call.
    • HTTP Method: The HTTP method associated with the call, one of HEAD, GET, POST, PUT, PATCH, DELETE, OPTIONS, CONNECT, or TRACE.
    • Response Time: The response time of the call in milliseconds.
    • Request Body: The request body associated with the call if present.
    • Response Body: The response body associated with the call if present.
    • HTTP Status Code: The HTTP status code associated with the call.

  • Troubleshooting Messages: Additional log messages to help with troubleshooting connector issues.

Log messages will also include the Harmony organization ID and environment ID associated with the project as orgId and envId respectively:

2023-05-07 18:13:42 http-nio-127.0.0.1-46912-exec-6 DEBUG org.jitterbit.connector.<connector_name>.Connection:80 [orgId:-][envId: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:-][envId:100000] - Connection is closing...

Note

It is possible for log messages to contain an undefined organization ID ([orgId:-]) if messages are logged outside of operation runtime. For example, when testing a connector's connection configuration.