Skip to content


Islandora Workbench writes a log file for all tasks to a file named "workbench.log" in the directory Workbench is run from, unless you specify an alternative log file location using the log_file_path configuration option, e.g.:

log_file_path: /tmp/mylogfilepath.log


The only times that the default log file name is used instead of one defined in log_file_path is 1) when Workbench can't find the specified configuration file and 2) when Workbench finds the configuration file but detects that the file is not valid YAML, and therefore can't understand the value of log_file_path.

The log contains information that is similar to what you see when you run Workbench, but with time stamps:

24-Dec-20 15:05:06 - INFO - Starting configuration check for "create" task using config file create.yml.
24-Dec-20 15:05:07 - INFO - OK, configuration file has all required values (did not check for optional values).
24-Dec-20 15:05:07 - INFO - OK, CSV file input_data/metadata.csv found.
24-Dec-20 15:05:07 - INFO - OK, all 5 rows in the CSV file have the same number of columns as there are headers (5).
24-Dec-20 15:05:21 - INFO - OK, CSV column headers match Drupal field names.
24-Dec-20 15:05:21 - INFO - OK, required Drupal fields are present in the CSV file.
24-Dec-20 15:05:23 - INFO - OK, term IDs/names in CSV file exist in their respective taxonomies.
24-Dec-20 15:05:23 - INFO - OK, term IDs/names used in typed relation fields in the CSV file exist in their respective taxonomies.
24-Dec-20 15:05:23 - INFO - OK, files named in the CSV "file" column are all present.
24-Dec-20 15:05:23 - INFO - Configuration checked for "create" task using config file create.yml, no problems found.

It may also contain additional detail that would clutter up the console output, for example which term is being added to a vocabulary.

Appending to vs. overwriting your log file

By default, new entries are appended to this log, unless you indicate that the log file should be overwritten each time Workbench is run by providing the log_file_mode configuration option with a value of "w":

log_file_mode: w

Logging debugging information

Workbench doesn't provide a way to set the amount of detail in its log, but several options are available that are useful for debugging and troubleshooting. These options, when set to true, write raw values used in the REST requests to Drupal:

  • log_request_url: Logs the request URL and its method (GET, POST, etc.).
  • log_json: Logs the raw JSON that Workbench uses in POST, PUT, and PATCH requests.
  • log_headers: Logs the raw HTTP headers used in all requests.
  • log_response_status_code: Logs the HTTP response code.
  • log_response_body: Logs the raw HTTP response body.

Another configuration setting that is useful during debugging is log_file_name_and_line_number, which, as the name suggests, adds to all log entries the filename and line number where the entry was generated.

These options can be used independently of each other, but they are often more useful for debugging when used together.


Using these options, especially log_json and log_response_body, can add a lot of data to you log file.