PDI logging

You can troubleshoot issues without having to examine the comprehensive log of server executions with PDI logging. PDI logging contains transformation and job logs for both PDI client and Pentaho Server executions in a separate log file from the comprehensive logging data.

For information on comprehensive logging, see Pentaho logging in the Pentaho Data Integration document.

Set up the log file

Transformation and job logging is enabled by default, and the PDI client and Pentaho Server are configured separately. Perform the following steps to reconfigure the logging for the Pentaho Server or PDI client:

1. Stop all relevant servers or exit the PDI client.

2. Navigate to the following directory and open the log4j2.xml file with any text editor:

Pentaho Server	server/pentaho-server/tomcat/webapps/pentaho/WEB-INF/classes
PDI client	design-tools/data-integration/classes

3. Set your desired logging levels in the XML <Logger> elements for o`rg.pentaho.di.trans.Trans` and `org.pentaho.di.job.Job`. You can set different logging levels for transformations than for jobs. The following table maps PDI logging levels to the corresponding Apache Log4j levels:

|PDI Log Level|Log4j Log Level|
|-------------|---------------|
|BASIC|INFO|
|DETAILED|INFO|
|MINIMAL|WARN|
|DEBUG|DEBUG|
|ERROR|ERROR|
|ROWLEVEL|TRACE|

4. Set your desired log file rotation (rollingPolicy) value by editing the FileNamePattern parameter in the log4j2.xml file for the pdi-execution-appender. The parameters are:

|Parameter|Description|
|---------|-----------|
|**yyyy-MM-dd**|Specify a daily rotation \(Default\).|
|**yyyy-MM**|Specify a monthly rotation.|
|**yyyy-MM-dd-HH-mm**|Specify a rotation every minute.|

5. Save and close the file, then start all affected servers or the PDI client to test the configuration.

Use the log file

The log files are located in the following directories:

Pentaho Server	server/pentaho-server/logs/pdi.log
PDI client	design-tools/data-integration/logs/pdi.log

Navigate to a log file and open the file to view the contents. The log entry fields in the log files are:

Field	Description
DateTimeStamp	Date and time of the log
LogThreshold	Logging level (INFO, ERROR, DEBUG, WARN, or TRACE)
ThreadID	Unique key for the job or transformation execution
Filepath	Absolute path of the transformation or job
Message	Log message

The following is an example of a log entry:

2018-03-07 11:40:36.290 INFO <Launch transformation UUID: 1246b616-a845-4cbc-9f4c-8a4a2cbfb4f1> [C:\build\pdi-ee-client-8.1.0.0-267\data-integration\samples\jobs\run_all\Run all sample transformations.kjb file:///C:/build/pdi-ee-client-8.1.0.0-267/data-integration/samples/jobs/run_all/Define FILENAME Variable and execute.kjb] Starting entry

This entry contains these values for the following fields:

Field	Description
DateTimeStamp	2018-03-07 11:40:36.290
LogThreshold	INFO
ThreadID	<Launch transformation UUID: 1246b616-a845-4cbc-9f4c-8a4a2cbfb4f1>
Filepath	[C:\build\pdi-ee-client-8.1.0.0-267\data-integration\samples\jobs\run_all\Run all sample transformations.kjb file:///C:/build/pdi-ee-client-8.1.0...run_all/DefineFILENAME Variable and execute.kjb]
Message	Starting entry