Pentaho Support Utility

The Pentaho Support Utility collects environment and configuration details into a single zip file that you can attach to your support ticket. This gives the support team immediate access to the background information they need to diagnose and resolve your issue, reducing back-and-forth requests for additional files and minimizing the time you spend gathering data.

The utility is supported on Pentaho versions 7.x, 8.x, 9.x, and 10.x. For a complete list of supported software and hardware, refer to the Components Reference in Pentaho Documentation.

Three tools are available for running the utility:

Pentaho Server Plugin: provides a UI within the Pentaho Server to gather information from the currently running server instance.

Pentaho Data Integration Plugin: operates within Spoon to collect details from your PDI environment.

Command Line Utility: offers a standalone option for gathering information from either the Pentaho Server or PDI without requiring a running application.

The server and PDI plugins are the preferred methods for running the utility. Use the command line tool only when Pentaho fails to start or when organizational policies prohibit plugin installation.

If any individual collector fails during execution, the remaining collectors will continue to run and the resulting report will still provide value to the support team. You can identify failed collectors by reviewing the utility logs or checking for .failed files within the output zip.

Some collected files and configuration details may contain passwords. While the utility attempts to remove all passwords during collection, Pentaho cannot guarantee complete removal in every case - particularly for files such as kettle.properties.

1. Download the Pentaho Support Utility.

https://hcpanywhere.hitachivantara.com/userportal/?v=4.6.1#/shared/public/8eUdzjLlHa7j5R3R/245ce549-c03a-4ee7-adae-d5ea655af8adhcpanywhere.hitachivantara.com

Support Utilities

1. Select Pentaho Product:

Pentaho Server

To install the Pentaho Server Plugin:

1. Download: pentaho-support-utility-server-plugin.zip file.
2. Unzip this file to: pentaho-server/pentaho-solutions/system.

cd
cd ~/Downloads/'Support Utility'/
unzip pentaho-support-utility-server-plugin-1.0.1.zip -d /opt/pentaho/server/pentaho-server/pentaho-solutions/system

If needed, configure the password removal regular expression.

1. Restart the Pentaho Server.

cd
cd /opt/pentaho/server/pentaho-server
./stop-pentaho.sh

cd
cd /opt/pentaho/server/pentaho-server
./start-pentaho.sh