Added by Jem Matzan, last edited by Marina Baker on Jun 04, 2008  (view change)

Labels:

spoon spoon Delete
log log Delete
logging logging Delete
logs logs Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Logging

Logging Description

A log view tab will open automatically each time you run a transformation or job. The log grid displays a list of transformation steps or job entries for the current execution. The log text shows log information based on the current logging level.

Log Grid

The log grid is actually a tree that offers a hierarchical view on the execution of a transformation or job. Transformation steps and Job entries will be highlighted in red as seen above if they fail during execution.

Transformation Log Grid Details

The log grid displays the following details for each step running in the transformation:

Option Description
Stepname The name of the step
Copynr Copy number of the step
Read Number of lines read from input-streams
Written Number of lines written to output-streams
Input Number of lines read from file or database
Output Number of lines written to file or database
Updated Number of lines updated in the database
Rejected Number of errors that occurred
Errors The status of the step: running, finished or stopped
Active The number of seconds that the step has been running.
Time The speed in rows per second at which the step processes rows.
Speed Priority of the step (10=highest, 1=lowest), nr of rows in the input-stream(s), nr of rows in the output-stream(s).
input/output Sleep time (get/put) is the time that a step had to go to sleep (in nano seconds) because the input buffer was empty (get) or the output buffer was full (put).

Note: The system is tuning the steps priority in such a way that the slowest steps get the highest priority.

Job Log Grid

The log grid displays the following details for each job entry executing in the Job:

Option Description
Job/Job Entry The name of the job / job entry
Comment A comment on the state of the entry execution
Result The result (success or failure) of the job entry
Reason Reason: why was this job entry started?
Nr The value of the nr variable in the result object (available in evaluation Javascript)
Log date Log date: logging date, corresponds with the start or end of the job entry.

Buttons

Transformation Buttons

Start

This button starts the transformation. Please note that Spoon tries to launch this from the XML-file or repository. It is therefore necessary that the transformation is saved. The output of the execution is displayed in the Log Text part of the Log View.

Preview (debug)

This button launches the Transformation Debug dialog allowing you to specify the number of rows to preview and define conditional breakpoints for the preview execution. After configuring the debug information, click the 'Quick Launch' button to begin the preview execution for the currently selected step. The output of the execution is displayed in the Log Text part of the Log View.

Debug Options

The following table provides a detailed description of the debug options:

Option Description
Step List The step list on the left displays a list of available steps from the current transformation. Select a step to begin configuring related options like number of rows and break-points.
Number of rows to retrieve Enter the rows per step you want to preview for the selected step. After the requested rows are obtained from the different steps, the transformation is ended and the result is shown.

Note: This option will only take effect when the 'Retrieve first rows' option is checked.

Retrieve first rows (preview) Enable this to restrict the preview size to the number of rows specified above.
Pause transformation on condition Enable this option to cause the transformation to pause if one of the conditional break-points evaluates to true during execution.
Break-point/pause condition Enter conditions based on comparing one field to another field or value.

Show error lines

This button displays all lines of the Log Text that contain the word ERROR (lower- or uppercase). You can then choose to edit the source step of the error.

Clear log

This clears the text in the Log Text Window.

Log Settings

If you put a text in the filter field, only the lines that contain this text will be shown in the Log Text window. The "Log level" setting allows you to select the logging level. You can choose one of these:

  • Nothing: Don't show any output
  • Error: Only show errors
  • Minimal: Only use minimal logging
  • Basic: This is the default basic logging level
  • Detailed: Give detailed logging output
  • Debug: For debugging purposes, very detailed output.
  • Row level: Logging at a row level, this can generate a lot of data.

If the "Enable time" option is enabled, all lines in the logging will be preceded by the time of day.

Hide inactive

Checking this hides all steps that finished processing.

Safe mode

Places the transformation in Safe Mode. Additional row checking is enabled at runtime, see also Safe mode.

Job Buttons

Start job

This button begins execution of the current Job. Please note that Spoon launches attempts to launch the job from an XML file or the Kettle repository. It is therefore necessary that the job is saved. The output of the execution is displayed in the Log Text part of the Log View.

Stop job

This button stops a running job.

Refresh log

Refreshes the log window.

Clear log

This clears the text in the Log Text Window.

Log Settings

If you put a text in the filter field, only the lines that contain this text will be shown in the Log Text window. The "Log level" setting allows you to select the logging level. You can choose one of these:

  • Error: Only show errors
  • Nothing: Don't show any output
  • Minimal: Only use minimal logging
  • Basic: This is the default basic logging level
  • Detailed: Give detailed logging output
  • Debug: For debugging purposes, very detailed output.
  • Row level: Logging at a row level, this can generate a lot of data.

If the "Enable time" option is enabled, all lines in the logging will be preceded by the time of day.

Auto-refresh

Enable this option to disable the logging window from updating all the time. You might want to do this when you're using a remote desktop (VNC, X11) over a slow network connection.