Skip to end of metadata
Go to start of metadata

Introduction

Certain logs are created and available only on Private Agents and can be used for debugging purposes as described on this page:

Verbose logging for Cloud Studio connectors is covered separately in Verbose Logging for Connectors and Private Agents.

Some additional log files for Private Agents are also described in Jitterbit Log File Locations.

Standard operation logging and API debug logging is supported on both Private and Cloud Agents. For standard operation logging, see Activities (Management Console), Operation Logs (Cloud Studio), or Reviewing an Operation Log (Design Studio). For API debug logging, see the setting Enable Debug Mode Until in Step 1: Settings of Custom API and OData Service Configuration.

Operation Debug Logs

Operation debug logging allows you to log debug messages to files on a Private Agent. Operation debug logging is used mainly for debugging problems during testing and should not be turned on in a production environment.

Operation debug logging can be enabled for a single operation or for an entire Private Agent. Regardless of the scope of operation debug logging, accessing operation debug logs can be done from the Management Console or directly from the agent machine.

CAUTION: When operation debug logging is turned on, generated files may be large in quantity and/or size. It is recommended to disable debug logging as soon as possible.

Single Operation

Selective debug logging can help if you are having issues with a particular operation and do not need to turn on debug logging for the agent, which may generate files that are large in quantity and/or size.

You can enable debug logging for a particular operation using either Cloud Studio or Design Studio:

  • Cloud Studio: Use an operation's actions menu to select Settings. In the Options tab, select Enable Debug Mode Until and set a date for debug logging to be turned off. For more information, see Cloud Studio Operation Options.
  • Design Studio: Right-click the background of any operation and select Options. In the Operation Options window, select Enable Debug Mode Until and set a date for debug logging to be turned off. For more information, see Design Studio Operation Options.

This date is limited to 2 weeks from the current date. Debugging will be turned off at the beginning of this date (that is, at 12:00 AM) using the time zone of the agent.

Entire Private Agent

Debug logging can be enabled from the Private Agent configuration file (jitterbit.conf) for all operations running on the Private Agent.

CAUTION: Enabling debug logging at the agent level may create very large files in the directory of each Private Agent within the Private Agent Group. If you are having issues with a particular operation, consider enabling debug logging for a single operation instead.

To enable debug logging, edit the jitterbit.conf file as follows, and then restart Jitterbit services.

  • Under the [TransformationEngine] section, set WriteLog=true.

  • Under the [OperationEngine] section, set Debug=true.

The files created in this directory can become very large. Turn off debug logging as soon as you can, and delete the files when they are no longer needed.

Complete instructions for editing the configuration file, as well as restarting Jitterbit services, are covered in Editing the Configuration File - jitterbit.conf.

Accessing Operation Debug Logs

You can download Private Agent debug log files from the Management Console on these pages:

  • Agents: From the Agents > Agents page, select the agent, and then use the Actions dropdown to select Download Agent Log.
  • Activities: From the Activities page, select the operation, then go to the Debug Files tab and use the link to download the logs.

On a Private Agent, you can also access the logs directly in these default locations:

  • Windows: C:\Program Files\Jitterbit Agent\DataInterchange\Temp\Debug
  • Linux: /usr/local/jitterbit/DataInterchange/Temp/Debug

Debug log files will be deleted automatically after 1 day by default. This time period is configurable in CleanupRules.xml.

Jitterbit Tomcat Server Logs

To enable more detailed logging for the Jitterbit Tomcat server, edit the Private Agent configuration file (jitterbit.conf) as follows, and then restart Jitterbit services.

  • Under the [JavaBackend] section, set DebugLogLevel=ALL.

  • Under the [JavaUiBackend] section, set LogLevel=ALL.

  • Under the [JdbcEngine] section, set LogLevel=ALL.

The logs are written to these default locations:

  • Windows: C:\Program Files\Jitterbit Agent\tomcat\logs
  • Linux: /opt/jitterbit/tomcat/logs

Jitterbit Tomcat server logs will be deleted automatically after 7 days by default. This time period is configurable in CleanupRules.xml.

Curl Debug Logs

Curl debugging can be used to turn on detailed tracing of FTP and HTTP connections.

To enable Curl debugging, edit the Private Agent configuration file (jitterbit.conf) as follows, and then restart Jitterbit services.

Under the [Settings] section, set CurlDebugDir to the path of an existing directory where Jitterbit processes have write permission. Each FTP and HTTP connection will create a separate file in this directory.

Use forward slashes for the directory, even on Windows. For example:

CurlDebugDir='C:/Temp/JitterbitData/Curl'

The logs are written to the specified directory path.

CAUTION: When you are done with the Curl logs, remember to disable Curl debugging. As numerous files are generated, forgetting to disable Curl debugging could cause space issues on the agent.