Enabling Debug Logging

Introduction

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

CAUTION: When debug logging is turned on, generated files may be large in quantity and/or size. If you enable debug logging, it is recommended to disable debug logging as soon as you are finished.

Debug logging can be enabled for a single operation, for a specific API, or for the entire agent.

WARNING: Downloading of log files is disabled on agents in a Cloud Agent Group. For security, logs from Agents in a Cloud Agent Group are removed as soon as they are no longer required for an operation to execute properly. Though a download link may show in the Management Console, you will receive an error message if you attempt to download using that link.

Enable for an 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: In the top right of an operation, click the actions menu icon to open the actions menu. From the menu, 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 on 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 timezone of the agent.

Enable for a Custom API

If you want to enable debug logging for a custom Jitterbit API, you can do so separately per API.

When this option is set, debugging will automatically be enabled on all of the operations triggered by the API.

To enable debug logging for an API, when editing a specific API via the API Manager, select the checkbox for Enable Debug Mode Until and set a date for debug logging to be turned off. 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 timezone of the agent.

Debug mode enables full tracing for every request received via this URL. When enabled, the system will retain complete content of each API request and API response for up to 24 hours from the time API call was made and will enable debugging on all of the operations triggered by the API.

CAUTION: Traversing through the event data may become difficult with large volumes, such as might be generated when load testing or pre-production testing. Because of the increase of data retained, depending on the scenario, storage space and security could become a concern. It is recommended to disable debug mode before using in a production environment.

TIP: For more information, see API Manager.

Enable for Entire Agent

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

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

To enable debug logging, edit the jitterbit.conf file as follows, 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. The files will be deleted automatically after one day by default. This time period is configurable in CleanupRules.xml.

TIP: Complete instructions for editing the config file remotely or manually, as well as restarting Jitterbit services, are covered in Editing the Configuration File - jitterbit.conf.

Check Debug Logs

You can download debug logs file from the Management Console on these pages:

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

TIP: For more information, see Agents > Agents and Activities.

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

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

Other Logging Options

These additional logging options are also available.

Jitterbit Tomcat

To enable more detailed logging for the Jitterbit Tomcat server, edit the Jitterbit configuration file (jitterbit.conf) as follows, 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 (x86)\Jitterbit Agent\tomcat\logs
Linux: /opt/jitterbit/tomcat/logs

FTP/HTTP Transfers

Curl debugging can be used to turn on detailed trace of FTP and HTTP transfers.

To enable Curl debugging, edit the Jitterbit configuration file (jitterbit.conf) as follows, 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/HTTP connection will create a separate file in this directory.

Use forward slashes for the directory even on Windows, e.g. CurlDebugDir='C:/Temp/JitterbitData/Curl'.

The logs are written to the specified directory path.

CAUTION: When you are done, remember to disable Curl debugging. A lot of files are generated, so if you forget to disable Curl debugging, this could cause space issues on the agent.

On This Page

Related Articles

Related Topics

Last updated: Oct 04, 2019

PAGE TREE